[Home]

Summary:ASTERISK-17082: [patch] doc/tex dir removed, but corresponding entries in Makefile & README still exists
Reporter:bas (bas)Labels:
Date Opened:2010-12-08 21:10:43.000-0600Date Closed:2011-02-01 12:03:49.000-0600
Priority:MinorRegression?No
Status:Closed/CompleteComponents:Documentation
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) changes.diff
( 1) Makefile_1.8.1_TEXDOC.diff
( 2) patch-Makefile.patch
( 3) patch-README.patch
( 4) README_DOC.diff
( 5) readme.diff
Description:Directory doc/tex removed (2010-11-11 22:17 +0000 [r294740-294745]  Russell Bryant <russell@digium.com> @ Changelog), but corresponding entries in README and Makefile still exists.
Comments:By: Andrew Latham (lathama) 2010-12-09 10:05:30.000-0600

Are you using SVN or Tar.Gz
By: bas (bas) 2010-12-09 11:49:21.000-0600

1.8.1 tar.gz from http://downloads.asterisk.org/pub/telephony/asterisk/asterisk-1.8.1.tar.gz

In suggested patch you have only removed doc/tex; but we need new section, about new docs.


By: Andrew Latham (lathama) 2010-12-09 11:54:27.000-0600

Downloading now to check, will take a few minutes over the international link...
By: Andrew Latham (lathama) 2010-12-09 12:01:44.000-0600

Diffs attached
By: bas (bas) 2010-12-10 02:40:45.000-0600

I suggest new patches.

It adds info about both AST.(txt|pdf) and install any doc from doc/


By: Andrew Latham (lathama) 2010-12-10 04:53:13.000-0600

Readme patch looks good, I don't really use the docs on the system.
By: Andrew Latham (lathama) 2010-12-16 09:47:30.000-0600

A grep for various forms of "/doc/" turns up many references in the manager help and other error messages...

eg...


config.c: * See doc/realtime.txt and doc/extconfig.txt

res_srtp.c:/* See doc/tex/secure-calls.tex for SRTP usage information */

res_timing_dahdi.c:#define SEE_TIMING "For more information on Asterisk timing modules, including ways to potentially fix this problem, please see doc/timing.txt\n"

app_voicemail.c: * \note For information about voicemail IMAP storage, read doc/imapstorage.txt

func_callcompletion.c:                  For more information on call completion in Asterisk, see <filename>doc/tex/ccss.tex</filename>.

chan_sip.c:                     ast_log(LOG_WARNING, "Retransmission timeout reached on transmission %s for seqno %d (%s %s) -- See doc/sip-retransmit.txt.\n"
chan_sip.c:             ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s)  -- See doc/sip-retransmit.txt.\n", pkt->owner->callid);
chan_sip.c:                     ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet (see doc/sip-retransmit.txt).\n", pkt->owner->callid);
README:the HTML version of the documentation in doc/tex/asterisk/index.html.  The
README:source for the security document is available in doc/tex/security.tex.

README:version of the documentation in doc/tex/asterisk.pdf.  Alternatively, pull up


By: Andrew Latham (lathama) 2010-12-17 12:04:54.000-0600

I will be happy to do the patches for these. Please make a suggestion on format.

eg...
"See http://wiki.asterisk.org or optionally /doc/AST.txt or /doc/AST.pdf if installed for more information."
By: Leif Madsen (lmadsen) 2011-01-20 09:26:07.000-0600

Could we just link to the new wiki pages instead of to the doc/ directory?
By: Leif Madsen (lmadsen) 2011-01-20 09:27:55.000-0600

Pointing to doc/AST.txt and doc/AST.pdf (and the relevant section names) also makes sense, but of course that only exists if it was built from a release... hmmm.


"See http://wiki.asterisk.org/wiki/<PAGE NAME> or the section on <SECTION NAME> in doc/AST.txt or doc/AST.pdf"
By: Leif Madsen (lmadsen) 2011-01-20 09:31:02.000-0600

BTW: I am presuming the patches here are still relevant and should be applied?
By: bas (bas) 2011-01-20 09:44:27.000-0600

My patch for Makefile is broken from beginning, sorry.
By: Andrew Latham (lathama) 2011-01-30 10:40:23.000-0600

I started working on this and will tag and close soon.  I am doing the relationships for the functions and applications and greping for the doc links at the same time.  There are a lot of them.
By: Andrew Latham (lathama) 2011-01-30 11:24:18.000-0600

readme.diff and changes.diff uploaded.

Can I get a little peer review on this.

* remove references to doc files that are gone
* change notes about asterisk.pdf to AST.pdf
* use http://wiki.asterisk.org as a general replacement.

The wiki url can be searched for later and updated if needed.
By: Andrew Latham (lathama) 2011-02-01 11:25:34.000-0600

What common text should be used to replace references to old documentation in the "doc" directory?
By: Digium Subversion (svnbot) 2011-02-01 12:02:07.000-0600

Repository: asterisk
Revision: 305560

_U  branches/1.8/
U   branches/1.8/CHANGES
U   branches/1.8/Makefile
U   branches/1.8/README

------------------------------------------------------------------------
r305560 | lathama | 2011-02-01 12:02:06 -0600 (Tue, 01 Feb 2011) | 13 lines

doc/tex dir removed, but corresponding entries still exists

Update README, CHANGES, and Makefile.  Direct users to
http://wiki.asterisk.org for documentation or to the
AST.txt and AST.pdf included in the tarball.

(closes issue ASTERISK-17082)
Reported by: bas
Patches:
     changes.diff uploaded by lathama (license 1028)
     readme.diff uploaded by lathama (license 1028)
Tested by: lathama bas

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=305560
By: Digium Subversion (svnbot) 2011-02-01 12:03:49.000-0600

Repository: asterisk
Revision: 305561

_U  trunk/

------------------------------------------------------------------------
r305561 | lathama | 2011-02-01 12:03:49 -0600 (Tue, 01 Feb 2011) | 14 lines

doc/tex dir removed, but corresponding entries still exists

Update README, CHANGES, and Makefile.  Direct users to
http://wiki.asterisk.org for documentation or to the
AST.txt and AST.pdf included in the tarball.

(closes issue ASTERISK-17082)
Reported by: bas
Patches:
     changes.diff uploaded by lathama (license 1028)
     readme.diff uploaded by lathama (license 1028)
Tested by: lathama bas


------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=305561