public inbox for cygwin-patches@cygwin.com
 help / color / mirror / Atom feed
* [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
@ 2021-02-15 22:35 Brian Inglis
  2021-02-16 11:30 ` Corinna Vinschen
  0 siblings, 1 reply; 6+ messages in thread
From: Brian Inglis @ 2021-02-15 22:35 UTC (permalink / raw)
  To: cygwin.patches, cygwin-patches

[-- Attachment #1: Type: text/plain, Size: 316 bytes --]


change notes to see "Implementation Notes" to xref to std-notes;
add xref to std-notes to getrlimit, setrlimit;
add note to document limitations of getrlimit, setrlimit resources support
---
 winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
 1 file changed, 57 insertions(+), 44 deletions(-)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-winsup-doc-posix.xml-add-note-for-getrlimit-setrlimit.patch --]
[-- Type: text/x-patch; name="0001-winsup-doc-posix.xml-add-note-for-getrlimit-setrlimit.patch", Size: 11249 bytes --]

diff --git a/winsup/doc/posix.xml b/winsup/doc/posix.xml
index 0669d07de890..360ee703f3dd 100644
--- a/winsup/doc/posix.xml
+++ b/winsup/doc/posix.xml
@@ -64,7 +64,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     atoi
     atol
     atoll
-    basename			(see chapter "Implementation Notes")
+    basename			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     bind
     bsearch
     btowc
@@ -126,8 +126,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     clock_getcpuclockid
     clock_getres
     clock_gettime
-    clock_nanosleep		(see chapter "Implementation Notes")
-    clock_settime		(see chapter "Implementation Notes")
+    clock_nanosleep		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    clock_settime		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     clog
     clogf
     clogl
@@ -242,7 +242,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     fchown
     fchownat
     fclose
-    fcntl			(see chapter "Implementation Notes")
+    fcntl			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     fdatasync
     fdim
     fdimf
@@ -292,7 +292,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     fopen
     fork
     fpathconf
-    fpclassify			(see chapter "Implementation Notes")
+    fpclassify			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     fprintf
     fputc
     fputs
@@ -347,7 +347,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     getgroups
     gethostid
     gethostname
-    getitimer			(see chapter "Implementation Notes")
+    getitimer			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     getline
     getlogin
     getlogin_r
@@ -367,7 +367,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     getpwnam_r
     getpwuid
     getpwuid_r
-    getrlimit
+    getrlimit			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     getrusage
     gets
     getservbyname
@@ -428,26 +428,26 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     iscntrl_l
     isdigit
     isdigit_l
-    isfinite			(see chapter "Implementation Notes")
+    isfinite			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     isgraph
     isgraph_l
-    isgreater			(see chapter "Implementation Notes")
-    isgreaterequal		(see chapter "Implementation Notes")
-    isinf			(see chapter "Implementation Notes")
+    isgreater			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    isgreaterequal		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    isinf			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     isless
-    islessequal			(see chapter "Implementation Notes")
-    islessgreater		(see chapter "Implementation Notes")
+    islessequal			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    islessgreater		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     islower
     islower_l
-    isnan			(see chapter "Implementation Notes")
-    isnormal			(see chapter "Implementation Notes")
+    isnan			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    isnormal			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     isprint
     isprint_l
     ispunct
     ispunct_l
     isspace
     isspace_l
-    isunordered			(see chapter "Implementation Notes")
+    isunordered			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     isupper
     isupper_l
     iswalnum
@@ -511,7 +511,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     localeconv
     localtime
     localtime_r
-    lockf			(see chapter "Implementation Notes")
+    lockf			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     log
     log10
     log10f
@@ -579,10 +579,10 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     mq_timedsend
     mq_unlink
     mrand48
-    msgctl			(see chapter "Implementation Notes")
-    msgget			(see chapter "Implementation Notes")
-    msgrcv			(see chapter "Implementation Notes")
-    msgsnd			(see chapter "Implementation Notes")
+    msgctl			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    msgget			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    msgrcv			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    msgsnd			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     msync
     munlock
     munmap
@@ -834,9 +834,9 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     sem_trywait
     sem_unlink
     sem_wait
-    semctl			(see chapter "Implementation Notes")
-    semget			(see chapter "Implementation Notes")
-    semop			(see chapter "Implementation Notes")
+    semctl			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    semget			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    semop			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     send
     sendmsg
     sendto
@@ -847,7 +847,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     setgid
     setgrent
     sethostent
-    setitimer			(see chapter "Implementation Notes")
+    setitimer			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     setjmp
     setkey			(available in external "crypt" library)
     setlocale
@@ -859,7 +859,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     setpwent
     setregid
     setreuid
-    setrlimit
+    setrlimit			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     setservent
     setsid
     setsockopt
@@ -869,10 +869,10 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     setvbuf
     shm_open
     shm_unlink
-    shmat			(see chapter "Implementation Notes")
-    shmctl			(see chapter "Implementation Notes")
-    shmdt			(see chapter "Implementation Notes")
-    shmget			(see chapter "Implementation Notes")
+    shmat			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    shmctl			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    shmdt			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    shmget			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     shutdown
     sigaction
     sigaddset
@@ -886,9 +886,9 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     sigismember
     siglongjmp
     signal
-    signbit			(see chapter "Implementation Notes")
+    signbit			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     signgam
-    sigpause			(see chapter "Implementation Notes")
+    sigpause			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     sigpending
     sigprocmask
     sigqueue
@@ -937,7 +937,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     strdup
     strerror
     strerror_l
-    strerror_r			(see chapter "Implementation Notes")
+    strerror_r			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     strfmon
     strfmon_l
     strftime
@@ -1001,7 +1001,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     tgammaf
     tgammal
     time
-    timer_create		(see chapter "Implementation Notes")
+    timer_create		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     timer_delete
     timer_getoverrun
     timer_gettime
@@ -1162,7 +1162,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     finitef
     finitel
     fiprintf
-    flock			(see chapter "Implementation Notes")
+    flock			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     fls
     flsl
     flsll
@@ -1212,7 +1212,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     madvise
     mkstemps
     openpty
-    qsort_r			(see chapter "Implementation Notes")
+    qsort_r			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     rcmd
     rcmd_af
     reallocarray
@@ -1257,7 +1257,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     valloc
     verr
     verrx
-    vhangup			(see chapter "Implementation Notes")
+    vhangup			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     vsyslog
     vwarn
     vwarnx
@@ -1291,14 +1291,14 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     asnprintf
     asprintf
     asprintf_r
-    basename			(see chapter "Implementation Notes")
+    basename			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     canonicalize_file_name
     clearenv
     clog10
     clog10f
     clog10l
     crypt_r			(available in external "crypt" library)
-    dladdr			(see chapter "Implementation Notes")
+    dladdr			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     dremf
     dup3
     envz_add
@@ -1370,8 +1370,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     ptsname_r
     putwc_unlocked
     putwchar_unlocked
-    renameat2			(see chapter "Implementation Notes")
-    qsort_r			(see chapter "Implementation Notes")
+    renameat2			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    qsort_r			<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     quotactl
     rawmemchr
     removexattr
@@ -1545,8 +1545,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     bcmp			(POSIX.1-2001, SUSv3)
     bcopy			(SUSv3)
     bzero			(SUSv3)
-    chroot			(SUSv2) (see chapter "Implementation Notes")
-    clock_setres		(QNX, VxWorks) (see chapter "Implementation Notes")
+    chroot			(SUSv2)		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
+    clock_setres		(QNX, VxWorks)	<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
     cuserid			(POSIX.1-1988, SUSv2)
     ecvt			(SUSv3)
     endutent			(XPG2)
@@ -1592,7 +1592,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
     ualarm			(SUSv3)
     usleep			(SUSv3)
     utmpname			(XPG2)
-    vfork			(SUSv3) (see chapter "Implementation Notes")
+    vfork			(SUSv3)		<xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
 </screen>
 
 </sect1>
@@ -1727,6 +1727,19 @@ flavors, depending on whether _GNU_SOURCE is defined when compiling.</para>
 <para><function>dladdr</function> always sets the Dl_info members dli_sname and
 dli_saddr to NULL, indicating no symbol matching addr could be found.</para>
 
+<para><function>getrlimit</function> resources RLIMIT_AS, RLIMIT_CPU,
+RLIMIT_FSIZE, RLIMIT_DATA always return rlim_cur and rlim_max as RLIM_INFINITY,
+so <function>setrlimit</function> returns -1 and sets EINVAL if they are
+lowered, or returns 0 if unchanged.
+<function>getrlimit</function> resource RLIMIT_NOFILE always returns rlim_cur
+and rlim_max as OPEN_MAX; <function>setrlimit</function> returns 0 sets EINVAL
+if rlim_cur > rlim_max, does not change the value if it is RLIM_INFINITY,
+otherwise returns the result from <function>setdtablesize</function>.
+<function>getrlimit</function>/<function>setrlimit</function> resources
+RLIMIT_CORE and RLIMIT_STACK return the current values and set the requested
+values.
+All other resource arguments return -1 and set EINVAL.</para>
+
 </sect1>
 
 </chapter>

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
  2021-02-15 22:35 [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes Brian Inglis
@ 2021-02-16 11:30 ` Corinna Vinschen
  2021-02-16 16:51   ` Brian Inglis
  0 siblings, 1 reply; 6+ messages in thread
From: Corinna Vinschen @ 2021-02-16 11:30 UTC (permalink / raw)
  To: cygwin-patches

Hi Brian,

On Feb 15 15:35, Brian Inglis wrote:
> 
> change notes to see "Implementation Notes" to xref to std-notes;
> add xref to std-notes to getrlimit, setrlimit;
> add note to document limitations of getrlimit, setrlimit resources support
> ---
>  winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
>  1 file changed, 57 insertions(+), 44 deletions(-)

Pushed with a change:

  <xref linkend="std-notes">(see chapter "Implementation Notes")</xref>

-->

  (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)

The reason is how xref is handled when creating html docs.  The result
of an xref is always 'the section called "..."'.  With the above change,
the text works (albeit differently) in html and info file.


Thanks,
Corinna


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
  2021-02-16 11:30 ` Corinna Vinschen
@ 2021-02-16 16:51   ` Brian Inglis
  2021-02-16 17:00     ` Brian Inglis
  0 siblings, 1 reply; 6+ messages in thread
From: Brian Inglis @ 2021-02-16 16:51 UTC (permalink / raw)
  To: cygwin-patches

On 2021-02-16 04:30, Corinna Vinschen via Cygwin-patches wrote:
> On Feb 15 15:35, Brian Inglis wrote:
>> change notes to see "Implementation Notes" to xref to std-notes;
>> add xref to std-notes to getrlimit, setrlimit;
>> add note to document limitations of getrlimit, setrlimit resources support
>> ---
>>   winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
>>   1 file changed, 57 insertions(+), 44 deletions(-)

> Pushed with a change:
>    <xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
> -->
>    (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
> The reason is how xref is handled when creating html docs.  The result
> of an xref is always 'the section called "..."'.  With the above change,
> the text works (albeit differently) in html and info file.

Cheers, thanks, I'll bear that in mind in future, and read the generated output 
more carefully.

I'm not seeing .info generated with Note:... links, is that okay?

Also ...api.pdf is not being regenerated, so what have I lost or am missing?

I have the following doc tools (and others):

$ apt l asciidoc dblatex poppler\$ xmlto
asciidoc 8.6.9-1 x86_64 [installed, manual]
dblatex 0.3.10-1 x86_64 [installed, automatic]
poppler 21.01.0-1 x86_64 [installed, manual]
xmlto 0.0.28-1 x86_64 [installed, automatic]

What else is needed?

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
  2021-02-16 16:51   ` Brian Inglis
@ 2021-02-16 17:00     ` Brian Inglis
  2021-02-17  9:29       ` Corinna Vinschen
  0 siblings, 1 reply; 6+ messages in thread
From: Brian Inglis @ 2021-02-16 17:00 UTC (permalink / raw)
  To: cygwin-patches

On 2021-02-16 09:51, Brian Inglis wrote:
> On 2021-02-16 04:30, Corinna Vinschen via Cygwin-patches wrote:
>> On Feb 15 15:35, Brian Inglis wrote:
>>> change notes to see "Implementation Notes" to xref to std-notes;
>>> add xref to std-notes to getrlimit, setrlimit;
>>> add note to document limitations of getrlimit, setrlimit resources support
>>> ---
>>>   winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
>>>   1 file changed, 57 insertions(+), 44 deletions(-)
> 
>> Pushed with a change:
>>    <xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
>> -->
>>    (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
>> The reason is how xref is handled when creating html docs.  The result
>> of an xref is always 'the section called "..."'.  With the above change,
>> the text works (albeit differently) in html and info file.
> 
> Cheers, thanks, I'll bear that in mind in future, and read the generated output 
> more carefully.
> 
> I'm not seeing .info generated with Note:... links, is that okay?
> 
> Also ...api.pdf is no longer being regenerated, so what have I lost or am missing?
> 
> I have the following doc tools (and others):
> 
> $ apt l asciidoc dblatex poppler\$ xmlto
> asciidoc 8.6.9-1 x86_64 [installed, manual]
> dblatex 0.3.10-1 x86_64 [installed, automatic]
> poppler 21.01.0-1 x86_64 [installed, manual]
> xmlto 0.0.28-1 x86_64 [installed, automatic]

Also as documented plus other dependencies:

$ apt l build-docbook-catalog docbook-sgml45 docbook-utils docbook-xml45 \
	docbook-xsl docbook2X
build-docbook-catalog 1.5-2 x86_64 [installed, automatic]
docbook-sgml45 4.5-1 x86_64 [installed, automatic]
docbook-utils 0.6.14-2 x86_64 [installed, manual]
docbook-xml45 4.5-1 x86_64 [installed, manual]
docbook-xsl 1.77.1-1 x86_64 [installed, automatic]
docbook2X 0.8.8-1 x86_64 [installed, manual]

> What else is needed?
-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
  2021-02-16 17:00     ` Brian Inglis
@ 2021-02-17  9:29       ` Corinna Vinschen
  2021-02-17 15:51         ` Brian Inglis
  0 siblings, 1 reply; 6+ messages in thread
From: Corinna Vinschen @ 2021-02-17  9:29 UTC (permalink / raw)
  To: cygwin-patches; +Cc: Jon TURNEY

On Feb 16 10:00, Brian Inglis wrote:
> On 2021-02-16 09:51, Brian Inglis wrote:
> > On 2021-02-16 04:30, Corinna Vinschen via Cygwin-patches wrote:
> > > On Feb 15 15:35, Brian Inglis wrote:
> > > > change notes to see "Implementation Notes" to xref to std-notes;
> > > > add xref to std-notes to getrlimit, setrlimit;
> > > > add note to document limitations of getrlimit, setrlimit resources support
> > > > ---
> > > >   winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
> > > >   1 file changed, 57 insertions(+), 44 deletions(-)
> > 
> > > Pushed with a change:
> > >    <xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
> > > -->
> > >    (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
> > > The reason is how xref is handled when creating html docs.  The result
> > > of an xref is always 'the section called "..."'.  With the above change,
> > > the text works (albeit differently) in html and info file.
> > 
> > Cheers, thanks, I'll bear that in mind in future, and read the generated
> > output more carefully.
> > 
> > I'm not seeing .info generated with Note:... links, is that okay?

db2x_docbook2texi from docbook2X is used for that.

> > Also ...api.pdf is no longer being regenerated, so what have I lost or am missing?

xmlto is doing this stuff, maybe the pdf option requires another package?

> > I have the following doc tools (and others):
> > 
> > $ apt l asciidoc dblatex poppler\$ xmlto
> > asciidoc 8.6.9-1 x86_64 [installed, manual]
> > dblatex 0.3.10-1 x86_64 [installed, automatic]
> > poppler 21.01.0-1 x86_64 [installed, manual]
> > xmlto 0.0.28-1 x86_64 [installed, automatic]
> 
> Also as documented plus other dependencies:
> 
> $ apt l build-docbook-catalog docbook-sgml45 docbook-utils docbook-xml45 \
> 	docbook-xsl docbook2X
> build-docbook-catalog 1.5-2 x86_64 [installed, automatic]
> docbook-sgml45 4.5-1 x86_64 [installed, automatic]
> docbook-utils 0.6.14-2 x86_64 [installed, manual]
> docbook-xml45 4.5-1 x86_64 [installed, manual]
> docbook-xsl 1.77.1-1 x86_64 [installed, automatic]
> docbook2X 0.8.8-1 x86_64 [installed, manual]
> 
> > What else is needed?

Good question.  I'm running that on Fedora with the following docbook
packages installed:

  docbook-dtds
  docbook-style-xsl
  docbook-style-dsssl
  docbook-utils
  docbook2X

xmlto adds a dependency to flex.  docbook2X depends on texinfo, texinfo
comes with a number of packages on the far side of infinity.

Jon?  Any idea?


Thanks,
Corinna

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes
  2021-02-17  9:29       ` Corinna Vinschen
@ 2021-02-17 15:51         ` Brian Inglis
  0 siblings, 0 replies; 6+ messages in thread
From: Brian Inglis @ 2021-02-17 15:51 UTC (permalink / raw)
  To: cygwin-patches

On 2021-02-17 02:29, Corinna Vinschen via Cygwin-patches wrote:
> On Feb 16 10:00, Brian Inglis wrote:
>> On 2021-02-16 09:51, Brian Inglis wrote:
>>> On 2021-02-16 04:30, Corinna Vinschen via Cygwin-patches wrote:
>>>> On Feb 15 15:35, Brian Inglis wrote:
>>>>> change notes to see "Implementation Notes" to xref to std-notes;
>>>>> add xref to std-notes to getrlimit, setrlimit;
>>>>> add note to document limitations of getrlimit, setrlimit resources support
>>>>> ---
>>>>>    winsup/doc/posix.xml | 101 ++++++++++++++++++++++++-------------------
>>>>>    1 file changed, 57 insertions(+), 44 deletions(-)
>>>
>>>> Pushed with a change:
>>>>     <xref linkend="std-notes">(see chapter "Implementation Notes")</xref>
>>>> -->
>>>>     (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
>>>> The reason is how xref is handled when creating html docs.  The result
>>>> of an xref is always 'the section called "..."'.  With the above change,
>>>> the text works (albeit differently) in html and info file.
>>>
>>> Cheers, thanks, I'll bear that in mind in future, and read the generated
>>> output more carefully.
>>>
>>> I'm not seeing .info generated with Note:... links, is that okay?
> 
> db2x_docbook2texi from docbook2X is used for that.

Cygwin provides db2x_texixml in docbook2X 0.8.8

>>> Also ...api.pdf is no longer being regenerated, so what have I lost or am missing?
> 
> xmlto is doing this stuff, maybe the pdf option requires another package?

I thought that was dblatex via TeX and/or poppler

>>> I have the following doc tools (and others):
>>>
>>> $ apt l asciidoc dblatex poppler\$ xmlto
>>> asciidoc 8.6.9-1 x86_64 [installed, manual]
>>> dblatex 0.3.10-1 x86_64 [installed, automatic]
>>> poppler 21.01.0-1 x86_64 [installed, manual]
>>> xmlto 0.0.28-1 x86_64 [installed, automatic]
>>
>> Also as documented plus other dependencies:
>>
>> $ apt l build-docbook-catalog docbook-sgml45 docbook-utils docbook-xml45 \
>> 	docbook-xsl docbook2X
>> build-docbook-catalog 1.5-2 x86_64 [installed, automatic]
>> docbook-sgml45 4.5-1 x86_64 [installed, automatic]
>> docbook-utils 0.6.14-2 x86_64 [installed, manual]
>> docbook-xml45 4.5-1 x86_64 [installed, manual]
>> docbook-xsl 1.77.1-1 x86_64 [installed, automatic]
>> docbook2X 0.8.8-1 x86_64 [installed, manual]
>>
>>> What else is needed?
> 
> Good question.  I'm running that on Fedora with the following docbook
> packages installed:
> 
>    docbook-dtds
>    docbook-style-xsl
>    docbook-style-dsssl
>    docbook-utils
>    docbook2X

Also got docbook-dsssl and all but docbook-xsl-ns - will install that

> xmlto adds a dependency to flex.  docbook2X depends on texinfo, texinfo
> comes with a number of packages on the far side of infinity.

Got bison, byacc, and flex; texinfo requires only a few std libs and perl 
modules, it's not La/TeX.

> Jon?  Any idea?

Last cygwin-api.pdf generated was 2020 Nov 10, last cygwin-ug-net.pdf generated 
was 2020 Dec 17.

Missed error ignored by build:

...
xmlto --skip-validation --with-dblatex pdf -o cygwin-api/ -m 
../../../../winsup/doc/fo.xsl ../../../../winsup/doc/cygwin-api.xml
Traceback (most recent call last):
   File "/usr/bin/dblatex", line 10, in <module>
     from dbtexmf.dblatex import dblatex
ModuleNotFoundError: No module named 'dbtexmf'
make[3]: [Makefile:128: cygwin-api/cygwin-api.pdf] Error 1 (ignored)
...

Looks like it was installed by dblatex in python2.7/site-packages which I wiped 
when I dropped python2 et. al. and upgraded to python3. Oops - my bad!

$ cygcheck -c dblatex
Cygwin Package Information
Package              Version        Status
dblatex              0.3.10-1       Incomplete

Thanks for help and sorry for wasting time.
I need to upgrade anyway as there is a backlog of 187 packages waiting for me to 
download 84MB including dblatex and python3!

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in binary units and prefixes, physical quantities in SI.]

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-02-17 15:51 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-02-15 22:35 [PATCH v2] winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes Brian Inglis
2021-02-16 11:30 ` Corinna Vinschen
2021-02-16 16:51   ` Brian Inglis
2021-02-16 17:00     ` Brian Inglis
2021-02-17  9:29       ` Corinna Vinschen
2021-02-17 15:51         ` Brian Inglis

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).