Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document app_rpt Defaults #335

Open
tsawyer opened this issue Jun 20, 2024 · 3 comments
Open

Document app_rpt Defaults #335

tsawyer opened this issue Jun 20, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tsawyer
Copy link
Member

tsawyer commented Jun 20, 2024

Build a list of hard coded defaults.

@tsawyer tsawyer added the documentation Improvements or additions to documentation label Jun 20, 2024
@Allan-N
Copy link
Collaborator

Allan-N commented Jun 20, 2024

Can you clarify the request? Are you asking for a list of every (rpt.conf, simpleusb.conf, usbradio.conf, ...) variable and their default values if not specified?

and are you looking for this information in a particular format? like a ".h" header file? a ".conf.sample" file, online documentation?

@tsawyer
Copy link
Member Author

tsawyer commented Jun 20, 2024

Yes, defaults of app_rpt and its channel drivers that are hard coded in the header files or wherever. @InterLinked1 may have input on Asterisk best practice for this but perhaps that's normally done in the .sample files.

@InterLinked1
Copy link
Member

InterLinked1 commented Jun 22, 2024

Yes, the sample files are the canonical place to document defaults. Usually each setting has each possible setting described and ends with "Default is yes" or "Default is no" or something like that.

Edit: XML documentation for the config file should also be added to app_rpt and friends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants