public inbox for newlib-cvs@sourceware.org
help / color / mirror / Atom feed
From: Yaakov Selkowitz <yselkowitz@sourceware.org>
To: newlib-cvs@sourceware.org
Subject: [newlib-cygwin] HOWTO: remove reference to TRAD_SYNOPSIS
Date: Fri, 01 Dec 2017 09:44:00 -0000	[thread overview]
Message-ID: <20171201094427.78838.qmail@sourceware.org> (raw)

https://sourceware.org/git/gitweb.cgi?p=newlib-cygwin.git;h=70afa0c7b31dd54fe6841d906afd3a8ae5c958cb

commit 70afa0c7b31dd54fe6841d906afd3a8ae5c958cb
Author: Yaakov Selkowitz <yselkowi@redhat.com>
Date:   Thu Nov 30 02:52:35 2017 -0600

    HOWTO: remove reference to TRAD_SYNOPSIS
    
    Signed-off-by: Yaakov Selkowitz <yselkowi@redhat.com>

Diff:
---
 newlib/HOWTO | 8 +-------
 1 file changed, 1 insertion(+), 7 deletions(-)

diff --git a/newlib/HOWTO b/newlib/HOWTO
index c5754e5..bb49e79 100644
--- a/newlib/HOWTO
+++ b/newlib/HOWTO
@@ -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"


                 reply	other threads:[~2017-12-01  9:44 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171201094427.78838.qmail@sourceware.org \
    --to=yselkowitz@sourceware.org \
    --cc=newlib-cvs@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).