sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
asterisk/doc
History
Ben Ford d5d8448ce5 build: Add staging directories for future changes. 
This is the first step in changing the release process so that changes
made to the CHANGES and UPGRADE.txt files do not result in merge
conflicts every time multiple people modify these files. The changes
made will go in these new directories: doc/CHANGES-staging and
doc/UPGRADE-staging. The README.md files explain how things will work,
but here's a little overview. When you make a change that would go in
either CHANGES or UPGRADE.txt, this should instead be documented in a
new file in the doc/CHANGES-staging or doc/UPGRADE-staging directory,
respectively. The format will look like this:

   Subject: res_pjsip

   A description that explains the changes made and why. The release
   script will handle the bulleting and section separators! The
   'Subject:' header is case-sensitive.

   You can still separate with new lines within your description.

   Subject: res_ari
   Master-Only: true

   You can have more than one subject, and they don't have to be the
   same! Also, the 'Master-Only' header should always be true and is
   also case-sensitive (but the value is not - you can have 'true' or
   'True'). This header will only ever be present in the master branch.

For more information, check out the wiki page:
https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt

This is an initial change for ASTERISK_28111. Functionally, this will
make no difference, but it will prep the directories for when the
changes from CHANGES and UPGRADE.txt are extracted.

Change-Id: I8d852f284f66ac456b26dcb899ee46babf7d15b6
 		2019-03-27 12:32:54 -06:00
..
CHANGES-staging build: Add staging directories for future changes. 2019-03-27 12:32:54 -06:00
UPGRADE-staging build: Add staging directories for future changes. 2019-03-27 12:32:54 -06:00
lang doc/lang/language-criteria.txt: Link to wiki. 2018-02-20 04:32:44 -06:00
.gitignore Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04:00
CODING-GUIDELINES Restore CODING-GUIDELINES to doc folder 2012-08-30 12:50:03 +00:00
IAX2-security.pdf Merged revisions 216008 via svnmerge from 2009-09-03 18:45:54 +00:00
IAX2-security.txt Merged revisions 216263 via svnmerge from 2009-09-04 10:48:44 +00:00
Makefile Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
README.txt Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
aelparse.8 doc: Add a manpage for the aelparse utility 2014-08-29 19:35:43 +00:00
appdocsxml.dtd func_channel: Reorganize documentation 2016-08-15 07:39:19 -05:00
appdocsxml.xslt appdocsxml.xslt: Add Language to channel snapshot transformation 2018-02-01 15:03:03 -06:00
astdb2bdb.8 Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
astdb2sqlite3.8 Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
asterisk-ng-doxygen.in progdocs: Exclude ./third-party from documentation generation 2016-03-19 17:51:41 -05:00
asterisk.8 Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
asterisk.sgml Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
smsq.8 doc: Add a manpage for the smsq utility 2014-08-29 19:40:34 +00:00

README.txt 

The vast majority of the Asterisk project documentation has been moved to the
project wiki:

    https://wiki.asterisk.org/

Asterisk release tarballs contain an export of the wiki in PDF and plain text
form, which you can find in:

    doc/AST.pdf
    doc/AST.txt

Asterisk uses the Doxygen documentation software.  Run "make progdocs" and open
the resulting documentation index at doc/api/index.html in a webbrowser or copy
the directory to a directory served by a webserver for remote access.