* [PATCH 2/4] fenv: Fix mangled makedoc markup
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
@ 2019-08-12 18:30 ` Jon Turney
2019-08-12 18:31 ` [PATCH 3/4] fenv: Fix typo-ed variable name in documentation Jon Turney
` (4 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Jon Turney @ 2019-08-12 18:30 UTC (permalink / raw)
To: newlib; +Cc: Jon Turney
See makedoc.c:657:
Variables are marked up as '<[foo]>'.
Code is marked up as '<<foo>>'.
---
newlib/libm/fenv/fegetexceptflag.c | 2 +-
newlib/libm/fenv/fesetenv.c | 4 ++--
newlib/libm/fenv/fesetexceptflag.c | 4 ++--
newlib/libm/fenv/feupdateenv.c | 6 +++---
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/newlib/libm/fenv/fegetexceptflag.c b/newlib/libm/fenv/fegetexceptflag.c
index e0e20b926..c2f854bb2 100644
--- a/newlib/libm/fenv/fegetexceptflag.c
+++ b/newlib/libm/fenv/fegetexceptflag.c
@@ -45,7 +45,7 @@ SYNOPSIS
DESCRIPTION
This method attempts to store an implementation-defined representation
of the states of the floating-point status flags specified by <[excepts]>
-in the memory pointed to by <[flagp>].
+in the memory pointed to by <[flagp]>.
RETURNS
If the information was successfully returned, this method returns
diff --git a/newlib/libm/fenv/fesetenv.c b/newlib/libm/fenv/fesetenv.c
index 410abcc4f..f2432e0fc 100644
--- a/newlib/libm/fenv/fesetenv.c
+++ b/newlib/libm/fenv/fesetenv.c
@@ -38,13 +38,13 @@ INDEX
SYNOPSIS
#include <fenv.h>
- int fesetenv(const fenv_t *[<envp>]);
+ int fesetenv(const fenv_t *<[envp]>);
Link with -lm.
DESCRIPTION
This method attempts to establish the floating-point environment
-pointed to by <[envp]>. The argument [<envp>] must point to a
+pointed to by <[envp]>. The argument <[envp]> must point to a
floating-point environment obtained via <<fegetenv>> or <<feholdexcept>>
or a floating-point environment macro such as <<FE_DFL_ENV>>.
diff --git a/newlib/libm/fenv/fesetexceptflag.c b/newlib/libm/fenv/fesetexceptflag.c
index 1f350933c..0e8ce1f5c 100644
--- a/newlib/libm/fenv/fesetexceptflag.c
+++ b/newlib/libm/fenv/fesetexceptflag.c
@@ -44,8 +44,8 @@ SYNOPSIS
DESCRIPTION
This method attempts to set the floating-point status flags specified
-by <[excepts]> to the states indicated by <[flagp>]. The argument
-[<flagp>] must point to an fexcept_t instance obtained via calling
+by <[excepts]> to the states indicated by <[flagp]>. The argument
+<[flagp]> must point to an fexcept_t instance obtained via calling
<<fegetexceptflag>> with at least the floating-point exceptions specified
by the argument <[excepts]>.
diff --git a/newlib/libm/fenv/feupdateenv.c b/newlib/libm/fenv/feupdateenv.c
index e1dd9657f..014440ba4 100644
--- a/newlib/libm/fenv/feupdateenv.c
+++ b/newlib/libm/fenv/feupdateenv.c
@@ -38,17 +38,17 @@ INDEX
SYNOPSIS
#include <fenv.h>
- int feupdateenv(const fenv_t *[<envp>]);
+ int feupdateenv(const fenv_t *<[envp]>);
Link with -lm.
DESCRIPTION
This method attempts to save the currently raised floating point
exceptions in its automatic storage, install the floating point
-environment specified by [<envp]>, and raise the saved floating
+environment specified by <[envp]>, and raise the saved floating
point exceptions.
-The argument [<envp>] must point to a floating-point environment
+The argument <[envp]> must point to a floating-point environment
obtained via <<fegetenv>> or <<feholdexcept>>.
RETURNS
--
2.21.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 0/4] fenv doc fixes
@ 2019-08-12 18:30 Jon Turney
2019-08-12 18:30 ` [PATCH 2/4] fenv: Fix mangled makedoc markup Jon Turney
` (5 more replies)
0 siblings, 6 replies; 7+ messages in thread
From: Jon Turney @ 2019-08-12 18:30 UTC (permalink / raw)
To: newlib; +Cc: Jon Turney
Jon Turney (4):
fenv: fe_dfl_env.c doesn't contain any documentation
fenv: Fix mangled makedoc markup
fenv: Fix typo-ed variable name in documentation
fenv: Update makedocbookpy for eae68bfc
newlib/doc/makedocbook.py | 4 +++-
newlib/libm/fenv/Makefile.am | 2 +-
newlib/libm/fenv/Makefile.in | 2 +-
newlib/libm/fenv/fegetexceptflag.c | 2 +-
newlib/libm/fenv/feraiseexcept.c | 2 +-
newlib/libm/fenv/fesetenv.c | 4 ++--
newlib/libm/fenv/fesetexceptflag.c | 4 ++--
newlib/libm/fenv/feupdateenv.c | 6 +++---
8 files changed, 14 insertions(+), 12 deletions(-)
--
2.21.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 4/4] fenv: Update makedocbookpy for eae68bfc
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
` (2 preceding siblings ...)
2019-08-12 18:31 ` [PATCH 1/4] fenv: fe_dfl_env.c doesn't contain any documentation Jon Turney
@ 2019-08-12 18:31 ` Jon Turney
2019-08-12 18:45 ` [PATCH 0/4] fenv doc fixes Joel Sherrill
2019-08-13 7:51 ` Corinna Vinschen
5 siblings, 0 replies; 7+ messages in thread
From: Jon Turney @ 2019-08-12 18:31 UTC (permalink / raw)
To: newlib; +Cc: Jon Turney
Teach makedocbook how to handle some new things seen in the makedoc markup
since eae68bfc:
- 'link with' lines appearing in SYNOPSIS sections
---
newlib/doc/makedocbook.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/newlib/doc/makedocbook.py b/newlib/doc/makedocbook.py
index cf48c3402..97255345d 100755
--- a/newlib/doc/makedocbook.py
+++ b/newlib/doc/makedocbook.py
@@ -297,6 +297,8 @@ def synopsis(c, t):
# preprocessor # directives, structs, comments in square brackets
funcsynopsisinfo = lxml.etree.SubElement(funcsynopsis, 'funcsynopsisinfo')
funcsynopsisinfo.text = l.strip() + '\n'
+ elif re.match('[Ll]ink with', l):
+ pass
else:
s = s + l
@@ -312,7 +314,7 @@ def synopsis(c, t):
if s.strip():
print("surplus synopsis '%s'" % s, file=sys.stderr)
- raise
+ exit(1)
def synopsis_for_prototype(funcsynopsis, s):
s = s.strip()
--
2.21.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 1/4] fenv: fe_dfl_env.c doesn't contain any documentation
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
2019-08-12 18:30 ` [PATCH 2/4] fenv: Fix mangled makedoc markup Jon Turney
2019-08-12 18:31 ` [PATCH 3/4] fenv: Fix typo-ed variable name in documentation Jon Turney
@ 2019-08-12 18:31 ` Jon Turney
2019-08-12 18:31 ` [PATCH 4/4] fenv: Update makedocbookpy for eae68bfc Jon Turney
` (2 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Jon Turney @ 2019-08-12 18:31 UTC (permalink / raw)
To: newlib; +Cc: Jon Turney
fe_dfl_env.c doesn't contain any documentation, so drop it from makedoc
processing.
---
newlib/libm/fenv/Makefile.am | 2 +-
newlib/libm/fenv/Makefile.in | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/newlib/libm/fenv/Makefile.am b/newlib/libm/fenv/Makefile.am
index fef5c3609..8d7a70273 100644
--- a/newlib/libm/fenv/Makefile.am
+++ b/newlib/libm/fenv/Makefile.am
@@ -24,7 +24,7 @@ endif # USE_LIBTOOL
include $(srcdir)/../../Makefile.shared
-CHEWOUT_FILES = feclearexcept.def fe_dfl_env.def fegetenv.def \
+CHEWOUT_FILES = feclearexcept.def fegetenv.def \
fegetexceptflag.def fegetround.def feholdexcept.def \
feraiseexcept.def fesetenv.def fesetexceptflag.def fesetround.def \
fetestexcept.def feupdateenv.def
diff --git a/newlib/libm/fenv/Makefile.in b/newlib/libm/fenv/Makefile.in
index 4e7f9a555..c8760b2a7 100644
--- a/newlib/libm/fenv/Makefile.in
+++ b/newlib/libm/fenv/Makefile.in
@@ -266,7 +266,7 @@ DOCBOOK_CHEW = ${top_srcdir}/../doc/makedocbook.py
DOCBOOK_OUT_FILES = $(CHEWOUT_FILES:.def=.xml)
DOCBOOK_CHAPTERS = $(CHAPTERS:.tex=.xml)
CLEANFILES = $(CHEWOUT_FILES) $(DOCBOOK_OUT_FILES)
-CHEWOUT_FILES = feclearexcept.def fe_dfl_env.def fegetenv.def \
+CHEWOUT_FILES = feclearexcept.def fegetenv.def \
fegetexceptflag.def fegetround.def feholdexcept.def \
feraiseexcept.def fesetenv.def fesetexceptflag.def fesetround.def \
fetestexcept.def feupdateenv.def
--
2.21.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 3/4] fenv: Fix typo-ed variable name in documentation
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
2019-08-12 18:30 ` [PATCH 2/4] fenv: Fix mangled makedoc markup Jon Turney
@ 2019-08-12 18:31 ` Jon Turney
2019-08-12 18:31 ` [PATCH 1/4] fenv: fe_dfl_env.c doesn't contain any documentation Jon Turney
` (3 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Jon Turney @ 2019-08-12 18:31 UTC (permalink / raw)
To: newlib; +Cc: Jon Turney
---
newlib/libm/fenv/feraiseexcept.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/newlib/libm/fenv/feraiseexcept.c b/newlib/libm/fenv/feraiseexcept.c
index c8f4b2efb..3f756589c 100644
--- a/newlib/libm/fenv/feraiseexcept.c
+++ b/newlib/libm/fenv/feraiseexcept.c
@@ -43,7 +43,7 @@ SYNOPSIS
DESCRIPTION
This method attempts to raise the floating-point exceptions specified
-in <[except]>.
+in <[excepts]>.
RETURNS
If the <[excepts]> argument is zero or all requested exceptions were
--
2.21.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 0/4] fenv doc fixes
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
` (3 preceding siblings ...)
2019-08-12 18:31 ` [PATCH 4/4] fenv: Update makedocbookpy for eae68bfc Jon Turney
@ 2019-08-12 18:45 ` Joel Sherrill
2019-08-13 7:51 ` Corinna Vinschen
5 siblings, 0 replies; 7+ messages in thread
From: Joel Sherrill @ 2019-08-12 18:45 UTC (permalink / raw)
To: Jon Turney; +Cc: Newlib
These all look good to me.
Sorry for the mistakes. Thank you for fixing them.
--joel
On Mon, Aug 12, 2019 at 1:30 PM Jon Turney <jon.turney@dronecode.org.uk>
wrote:
> Jon Turney (4):
> fenv: fe_dfl_env.c doesn't contain any documentation
> fenv: Fix mangled makedoc markup
> fenv: Fix typo-ed variable name in documentation
> fenv: Update makedocbookpy for eae68bfc
>
> newlib/doc/makedocbook.py | 4 +++-
> newlib/libm/fenv/Makefile.am | 2 +-
> newlib/libm/fenv/Makefile.in | 2 +-
> newlib/libm/fenv/fegetexceptflag.c | 2 +-
> newlib/libm/fenv/feraiseexcept.c | 2 +-
> newlib/libm/fenv/fesetenv.c | 4 ++--
> newlib/libm/fenv/fesetexceptflag.c | 4 ++--
> newlib/libm/fenv/feupdateenv.c | 6 +++---
> 8 files changed, 14 insertions(+), 12 deletions(-)
>
> --
> 2.21.0
>
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 0/4] fenv doc fixes
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
` (4 preceding siblings ...)
2019-08-12 18:45 ` [PATCH 0/4] fenv doc fixes Joel Sherrill
@ 2019-08-13 7:51 ` Corinna Vinschen
5 siblings, 0 replies; 7+ messages in thread
From: Corinna Vinschen @ 2019-08-13 7:51 UTC (permalink / raw)
To: Jon Turney; +Cc: newlib
[-- Attachment #1: Type: text/plain, Size: 805 bytes --]
On Aug 12 19:30, Jon Turney wrote:
> Jon Turney (4):
> fenv: fe_dfl_env.c doesn't contain any documentation
> fenv: Fix mangled makedoc markup
> fenv: Fix typo-ed variable name in documentation
> fenv: Update makedocbookpy for eae68bfc
>
> newlib/doc/makedocbook.py | 4 +++-
> newlib/libm/fenv/Makefile.am | 2 +-
> newlib/libm/fenv/Makefile.in | 2 +-
> newlib/libm/fenv/fegetexceptflag.c | 2 +-
> newlib/libm/fenv/feraiseexcept.c | 2 +-
> newlib/libm/fenv/fesetenv.c | 4 ++--
> newlib/libm/fenv/fesetexceptflag.c | 4 ++--
> newlib/libm/fenv/feupdateenv.c | 6 +++---
> 8 files changed, 14 insertions(+), 12 deletions(-)
>
> --
> 2.21.0
LGTM, please push.
Thanks,
Corinna
--
Corinna Vinschen
Cygwin Maintainer
Red Hat
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2019-08-13 7:51 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-08-12 18:30 [PATCH 0/4] fenv doc fixes Jon Turney
2019-08-12 18:30 ` [PATCH 2/4] fenv: Fix mangled makedoc markup Jon Turney
2019-08-12 18:31 ` [PATCH 3/4] fenv: Fix typo-ed variable name in documentation Jon Turney
2019-08-12 18:31 ` [PATCH 1/4] fenv: fe_dfl_env.c doesn't contain any documentation Jon Turney
2019-08-12 18:31 ` [PATCH 4/4] fenv: Update makedocbookpy for eae68bfc Jon Turney
2019-08-12 18:45 ` [PATCH 0/4] fenv doc fixes Joel Sherrill
2019-08-13 7:51 ` Corinna Vinschen
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).