diff options
| author | Yaakov Selkowitz <yselkowi@redhat.com> | 2017-11-30 02:52:35 -0600 |
|---|---|---|
| committer | Yaakov Selkowitz <yselkowi@redhat.com> | 2017-12-01 03:41:54 -0600 |
| commit | 70afa0c7b31dd54fe6841d906afd3a8ae5c958cb (patch) | |
| tree | 03807eb81ae2736d10e53a1e8f3fae408b62a9b2 /newlib/HOWTO | |
| parent | 9f369d3c8d4db0d7265cb6318407b6f0e7badffb (diff) | |
| download | newlib-70afa0c7b31dd54fe6841d906afd3a8ae5c958cb.zip newlib-70afa0c7b31dd54fe6841d906afd3a8ae5c958cb.tar.gz newlib-70afa0c7b31dd54fe6841d906afd3a8ae5c958cb.tar.bz2 | |
HOWTO: remove reference to TRAD_SYNOPSIS
Signed-off-by: Yaakov Selkowitz <yselkowi@redhat.com>
Diffstat (limited to 'newlib/HOWTO')
| -rw-r--r-- | newlib/HOWTO | 8 |
1 files changed, 1 insertions, 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" |