From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 78871 invoked by alias); 1 Dec 2017 09:44:28 -0000 Mailing-List: contact newlib-cvs-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: newlib-cvs-owner@sourceware.org Received: (qmail 78840 invoked by uid 9642); 1 Dec 2017 09:44:27 -0000 Date: Fri, 01 Dec 2017 09:44:00 -0000 Message-ID: <20171201094427.78838.qmail@sourceware.org> Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: Yaakov Selkowitz To: newlib-cvs@sourceware.org Subject: [newlib-cygwin] HOWTO: remove reference to TRAD_SYNOPSIS X-Act-Checkin: newlib-cygwin X-Git-Author: Yaakov Selkowitz X-Git-Refname: refs/heads/master X-Git-Oldrev: 9f369d3c8d4db0d7265cb6318407b6f0e7badffb X-Git-Newrev: 70afa0c7b31dd54fe6841d906afd3a8ae5c958cb X-SW-Source: 2017-q4/txt/msg00071.txt.bz2 https://sourceware.org/git/gitweb.cgi?p=newlib-cygwin.git;h=70afa0c7b31dd54fe6841d906afd3a8ae5c958cb commit 70afa0c7b31dd54fe6841d906afd3a8ae5c958cb Author: Yaakov Selkowitz Date: Thu Nov 30 02:52:35 2017 -0600 HOWTO: remove reference to TRAD_SYNOPSIS Signed-off-by: Yaakov Selkowitz 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"