]> sourceware.org Git - newlib-cygwin.git/commitdiff
HOWTO: remove reference to TRAD_SYNOPSIS
authorYaakov Selkowitz <yselkowi@redhat.com>
Thu, 30 Nov 2017 08:52:35 +0000 (02:52 -0600)
committerYaakov Selkowitz <yselkowi@redhat.com>
Fri, 1 Dec 2017 09:41:54 +0000 (03:41 -0600)
Signed-off-by: Yaakov Selkowitz <yselkowi@redhat.com>
newlib/HOWTO

index c5754e5b8d402f50092659d98c8117584f5590d5..bb49e79dda94b76cbf50412040804239de151c88 100644 (file)
@@ -47,14 +47,8 @@ but these, however, should be carefully limited and be given alternates for
 when a non-printed manual is produced--such as when info pages are produced.
 For an example of this kind of usage, see libm/common/s_logb.c.
 
-     Please note that most files with documentation contain both an
-ANSI_SYNOPSIS and a TRAD_SYNOPSIS section.  The TRAD_SYNOPSIS section gets
-deleted (since at least 2000) by makedoc, so when working on files these
-can safely be deleted and if you're making a new file, there is no need
-to add the TRAD_SYNOPSIS section.
-
      If writing a new function that requires documentation, the required
-sections are FUNCTION, INDEX, ANSI_SYNOPSIS (or SYNOPSIS), DESCRIPTION, RETURNS,
+sections are FUNCTION, INDEX, SYNOPSIS, DESCRIPTION, RETURNS,
 and PORTABILITY.  BUGS and SEEALSO should be added as appropriate.
 
      Source files which contain documentation are processed into ".def"
This page took 0.03137 seconds and 5 git commands to generate.