[Freeswitch-docs] Completed Variables List Published
Hi list, I've published the completed Variables Master List. It totals 638 variables! Wow! https://freeswitch.org/confluence/display/FREESWITCH/Variables+Master+List Now work can begin on making category pages or whatever.
Yay! On 8 February 2018 at 19:45, Ryan Harris <ryharris@airmail.cc> wrote:
Hi list,
I've published the completed Variables Master List. It totals 638 variables! Wow!
https://freeswitch.org/confluence/display/FREESWITCH/Variables+Master+List
Now work can begin on making category pages or whatever.
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
-- Sincerely, Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18
The page tells about "every variable defined in the documentation". Is this in the "documentation documentation" as in wiki and confluence, or in """documentation""" (triple quote) as in doxygen and source code? Eg, is it possible there are variables in code that do things if used, but are not in the page? -giovanni On 12 February 2018 at 14:55, Giovanni Maruzzelli <gmaruzz@gmail.com> wrote:
Yay!
On 8 February 2018 at 19:45, Ryan Harris <ryharris@airmail.cc> wrote:
Hi list,
I've published the completed Variables Master List. It totals 638 variables! Wow!
https://freeswitch.org/confluence/display/FREESWITCH/Variabl es+Master+List
Now work can begin on making category pages or whatever.
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
--
Sincerely,
Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18
-- Sincerely, Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18
I remember that around the time that I first started investigating FreeSWITCH (early 2012?) that there was talk of a script that could be run against FS source code to parse out all the variables used. I have no idea if it would still work after so many revisions to the source code, but if it does it might reveal new variables. BTW, this is the first I’ve seen these e-mails from Ryan, so they must have gotten stuck in a queue somewhere, we’re not ignoring you. Especially after all that effort! ¡Muchisimas gracias! Bote From: Freeswitch-docs [mailto:freeswitch-docs-bounces@lists.freeswitch.org] On Behalf Of Giovanni Maruzzelli Sent: Monday, 12 February, 2018 08:59 To: FreeSWITCH Docs Team <freeswitch-docs@lists.freeswitch.org> Subject: Re: [Freeswitch-docs] Completed Variables List Published The page tells about "every variable defined in the documentation". Is this in the "documentation documentation" as in wiki and confluence, or in """documentation""" (triple quote) as in doxygen and source code? Eg, is it possible there are variables in code that do things if used, but are not in the page? -giovanni On 12 February 2018 at 14:55, Giovanni Maruzzelli <gmaruzz@gmail.com <mailto:gmaruzz@gmail.com> > wrote: Yay! On 8 February 2018 at 19:45, Ryan Harris <ryharris@airmail.cc <mailto:ryharris@airmail.cc> > wrote: Hi list, I've published the completed Variables Master List. It totals 638 variables! Wow! https://freeswitch.org/confluence/display/FREESWITCH/Variables+Master+List Now work can begin on making category pages or whatever. _______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org <mailto:Freeswitch-docs@lists.freeswitch.org> http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs -- Sincerely, Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18 -- Sincerely, Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18
On 02/12/2018 10:03 AM, Bote Man wrote:
I remember that around the time that I first started investigating FreeSWITCH (early 2012?) that there was talk of a script that could be run against FS source code to parse out all the variables used. I have no idea if it would still work after so many revisions to the source code, but if it does it might reveal new variables.
Ah, the rich man's grep. I've been using `grep -r . -e "channel_set_variable"` to look around.
BTW, this is the first I’ve seen these e-mails from Ryan, so they must have gotten stuck in a queue somewhere, we’re not ignoring you. Especially after all that effort!
¡Muchisimas gracias!
It's a pleasure. What I've been doing so far is therapeutic. It's like spring cleaning! On 02/12/2018 08:59 AM, Giovanni Maruzzelli wrote:
Eg, is it possible there are variables in code that do things if used, but are not in the page?
That is correct - I would count on a lot of missing variables. All I've really done is remake the legacy wiki `Variable_` pages and make new pages for each variable on the Channel Variables page. And of course merged any discrepancies between the two pages. So I think right now, this is what is planned in quadrant one: 1. A differential report on which variables should be added to the docs and those which can confidently be removed. 2. Start work on providing examples and definitions to variables with missing descriptions (as close to 100% coverage as possible). In the second quadrant: - Begin maintaining this part of the documentation in a version control system, probably git. And automate the changes using the Confluence REST API. This would probably coincide with converting to something like reStructedText. We'll see. - Research "doctests". I envision running tests for all the examples on new releases to make sure the documentation is up-to-date with the current release.
:)))! On 12 February 2018 at 19:33, Ryan Harris <ryharris@airmail.cc> wrote:
On 02/12/2018 10:03 AM, Bote Man wrote:
I remember that around the time that I first started investigating FreeSWITCH (early 2012?) that there was talk of a script that could be run against FS source code to parse out all the variables used. I have no idea if it would still work after so many revisions to the source code, but if it does it might reveal new variables.
Ah, the rich man's grep. I've been using `grep -r . -e "channel_set_variable"` to look around.
BTW, this is the first I’ve seen these e-mails from Ryan, so they must have gotten stuck in a queue somewhere, we’re not ignoring you. Especially after all that effort!
¡Muchisimas gracias!
It's a pleasure. What I've been doing so far is therapeutic. It's like spring cleaning!
On 02/12/2018 08:59 AM, Giovanni Maruzzelli wrote:
Eg, is it possible there are variables in code that do things if used, but are not in the page?
That is correct - I would count on a lot of missing variables. All I've really done is remake the legacy wiki `Variable_` pages and make new pages for each variable on the Channel Variables page. And of course merged any discrepancies between the two pages.
So I think right now, this is what is planned in quadrant one:
1. A differential report on which variables should be added to the docs and those which can confidently be removed.
2. Start work on providing examples and definitions to variables with missing descriptions (as close to 100% coverage as possible).
In the second quadrant:
- Begin maintaining this part of the documentation in a version control system, probably git. And automate the changes using the Confluence REST API. This would probably coincide with converting to something like reStructedText. We'll see. - Research "doctests". I envision running tests for all the examples on new releases to make sure the documentation is up-to-date with the current release.
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
-- Sincerely, Giovanni Maruzzelli OpenTelecom.IT cell: +39 347 266 56 18
participants (3)
-
Bote Man
-
Giovanni Maruzzelli
-
Ryan Harris