* [PATCH 0/8] Generate utilities manpages
@ 2015-06-15 12:36 Jon TURNEY
2015-06-15 12:37 ` [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames Jon TURNEY
` (7 more replies)
0 siblings, 8 replies; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:36 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Sorry about the patch-bomb.
Currently, the manpages in the cygwin-doc package are generated by a conversion
from the DocBook XML by perl scripts with minimal understanding of the markup,
which gives sub-optimal results. I've been looking at doing that in a better
way.
This patch set changes the DocBook source XML for the Cygwin utilities to use
refentry entities, and also generates man pages from that.
Note that after this, the chunked html now has a page for each utility, rather
than one containing all utilities. This probably could be changed back with
further stylesheet customization, but I'm not sure that's required.
Jon TURNEY (8):
winsup/doc: Remove tarball target from .PHONY
winsup/doc: Fix xidepend to handle relative pathnames
winsup/doc: Some preparatory XML fixes
winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML
winsup/doc: Convert utils.xml to using refentry
winsup/doc: Make it easier to extend xidepend to more targets
winsup/doc: Make and install manpages for utils
winsup/doc: Fix an issue with parallel make
winsup/doc/ChangeLog | 46 +++
winsup/doc/Makefile.in | 40 +-
winsup/doc/cygwin-ug-net.xml | 1 -
winsup/doc/cygwin.xsl | 13 +
winsup/doc/fo.xsl | 36 ++
winsup/doc/utils.xml | 852 ++++++++++++++++++++++++++++++-------------
winsup/doc/xidepend | 3 +-
7 files changed, 730 insertions(+), 261 deletions(-)
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:02 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 7/8] winsup/doc: Make and install manpages for utils Jon TURNEY
` (6 subsequent siblings)
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
It seems that xidepend doesn't work correctly if we are ./configure'd using a
relative pathname to the srcdir:
$ make
cd ../../../../src/winsup/doc && ./xidepend ../../../../src/winsup/doc/cygwin-ug-net.xml ../../../../src/winsup/doc/cygwin-api.xml >"/wip/cygwin/build/x86_64-unknown-cygwin/winsup/doc/Makefile.dep"
grep: ../../../../src/winsup/doc/cygwin-ug-net.xml: No such file or directory
grep: ../../../../src/winsup/doc/cygwin-api.xml: No such file or directory
Although it might be better to fix this by making xidepend use pathnames, rather
than ignoring them and assuming everything is in the current directory...
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* xidepend: Fix to handle relative pathnames.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 4 ++++
winsup/doc/xidepend | 1 +
2 files changed, 5 insertions(+)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index aa45e3d..aac7b3d 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,9 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * xidepend: Fix to handle relative pathnames.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* Makefile.in (.PHONY): Remove tarball target.
2015-06-04 Jon Turney <jon.turney@dronecode.org.uk>
diff --git a/winsup/doc/xidepend b/winsup/doc/xidepend
index d3b233a..f476620 100755
--- a/winsup/doc/xidepend
+++ b/winsup/doc/xidepend
@@ -11,6 +11,7 @@ fi
for f in "$@"
do
+ f=`basename "$f"`
if fgrep -q 'xi:include' "$f"
then
# This file uses XIncludes. Let's chase its deps recursively.
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 8/8] winsup/doc: Fix an issue with parallel make
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
` (4 preceding siblings ...)
2015-06-15 12:37 ` [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:16 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML Jon TURNEY
2015-06-15 12:37 ` [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY Jon TURNEY
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
The cygwin-ug-net-nochunks.html.gz target does not ensure that the
cygwin-ug-net/ directory exists, so it can fail if run on it's own, or if the
cygwin-ug-net/cygwin-ug-net.html target has not yet created it in a parallel
make.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (cygwin-ug-net/cygwin-ug-net-nochunks.html.gz):
Ensure cygwin-ug-net directory exists.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 5 +++++
winsup/doc/Makefile.in | 1 +
2 files changed, 6 insertions(+)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index 341374f..ae78313 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,10 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * Makefile.in (cygwin-ug-net/cygwin-ug-net-nochunks.html.gz):
+ Ensure cygwin-ug-net directory exists.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* Makefile.in (install-man, utils2man.stamp): Add rules to build
and install manpages for utils.
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index bb2ad36..899c407 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -81,6 +81,7 @@ install-man: utils2man.stamp
cygwin-ug-net/cygwin-ug-net-nochunks.html.gz : $(cygwin-ug-net_SOURCES) cygwin.xsl
-$(XMLTO) html-nochunks -m $(srcdir)/cygwin.xsl $<
+ -@$(MKDIRP) cygwin-ug-net
-cp cygwin-ug-net.html cygwin-ug-net/cygwin-ug-net-nochunks.html
-rm -f cygwin-ug-net/cygwin-ug-net-nochunks.html.gz
-gzip cygwin-ug-net/cygwin-ug-net-nochunks.html
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 3/8] winsup/doc: Some preparatory XML fixes
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
` (2 preceding siblings ...)
2015-06-15 12:37 ` [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:04 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets Jon TURNEY
` (3 subsequent siblings)
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Remove the inconsistent .exe suffix in strace and umount usage lines.
Consistently refer to cross-references outside utils.xml as being in the Cygwin
User's Guide. This helps to generate sensible looking references in generated
manpages.
Tidy up some trailing whitespace.
Tabs inside <screen> are not consistently formatted by all formatters, replace
with spaces.
Remove pointlesss and incorrect date
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* cygwin-ug-net.xml: Remove incorrect unused date.
* utils.xml : Remove .exe suffix inconsistently added in a few
places. Consistently refer to cross-references outside this file
as in the Cygwin User's Guide. Tidy up some trailing whitespace.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 7 +++++
winsup/doc/cygwin-ug-net.xml | 1 -
winsup/doc/utils.xml | 74 +++++++++++++++++++++++---------------------
3 files changed, 45 insertions(+), 37 deletions(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index aac7b3d..46a7908 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,12 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * cygwin-ug-net.xml: Remove incorrect unused date.
+ * utils.xml : Remove .exe suffix inconsistently added in a few
+ places. Consistently refer to cross-references outside this file
+ as in the Cygwin User's Guide. Tidy up some trailing whitespace.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* xidepend: Fix to handle relative pathnames.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
diff --git a/winsup/doc/cygwin-ug-net.xml b/winsup/doc/cygwin-ug-net.xml
index 89526d7..f8b40e6 100644
--- a/winsup/doc/cygwin-ug-net.xml
+++ b/winsup/doc/cygwin-ug-net.xml
@@ -4,7 +4,6 @@
<book id="cygwin-ug-net" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
- <date>2009-03-18</date>
<title>Cygwin User's Guide</title>
<xi:include href="legal.xml"/>
</bookinfo>
diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index 673da3b..fcecd11 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -74,8 +74,8 @@ Note: -c, -f, and -l only report on packages that are currently installed. To
<command>dpkg</command> or <command>rpm</command>,
<command>cygcheck</command> is similar in many ways. (The major
difference is that <command>setup.exe</command> handles installing and
- uninstalling packages; see <xref linkend="internet-setup"/> for more
- information.) </para>
+ uninstalling packages; see <xref linkend="internet-setup"/> in the Cygwin
+ User's Guide for more information.) </para>
<para> The <literal>-c</literal> option checks the version and status of
installed Cygwin packages. If you specify one or more package names,
<command>cygcheck</command> will limit its output to those packages, or
@@ -265,9 +265,9 @@ are unable to find another Cygwin DLL.
<screen>
Usage: cygpath (-d|-m|-u|-w|-t TYPE) [-f FILE] [OPTION]... NAME...
- cygpath [-c HANDLE]
- cygpath [-ADHOPSW]
- cygpath [-F ID]
+ cygpath [-c HANDLE]
+ cygpath [-ADHOPSW]
+ cygpath [-F ID]
Convert Unix and Windows format paths, or output system path information
@@ -340,7 +340,8 @@ Other options:
options. The default is to use the character set of the current locale
defined by one of the internationalization environment variables
<envar>LC_ALL</envar>, <envar>LC_CTYPE</envar>, or <envar>LANG</envar>,
- see <xref linkend="setup-locale"/>. This is sometimes not sufficient for
+ (See <xref linkend="setup-locale"/> in the Cygwin User's Guide).
+ This is sometimes not sufficient for
interaction with native Windows tools, which might expect native,
non-ASCII characters in a specific Windows codepage. Console tools, for
instance, might expect pathnames in the current OEM codepage, while
@@ -518,7 +519,7 @@ Other options:
Usage: getfacl [-adn] FILE [FILE2...]
Display file and directory access control lists (ACLs).
-
+
-a, --access display the file access control list
-d, --default display the default access control list
-h, --help print help explaining the command line options
@@ -928,7 +929,7 @@ groups on domain controllers and domain member machines.
of your current account apply. The <literal>-l/-L</literal> when used
with a machine name, tries to contact that machine to enumerate local
groups of other machines, typically outside of domains. This scenario
- cannot be covered by Cygwin's account automatism. If you want to use
+ cannot be covered by Cygwin's account automatism. If you want to use
the <literal>-L</literal> option, but you don't like the default
domain/group separator from <filename>/etc/nsswitch.conf</filename>,
you can specify another separator using the <literal>-S</literal> option,
@@ -1025,7 +1026,7 @@ on domain controllers and domain member machines.
<para>For very simple needs, an entry for the current user can be created
by using the option <literal>-c</literal>.</para>
-
+
<para>The <literal>-o</literal> option allows for special cases (such as
multiple domains) where the UIDs might match otherwise. The
<literal>-p</literal> option causes <command>mkpasswd</command> to use
@@ -1074,7 +1075,8 @@ Display information about mounted filesystems, or mount a filesystem
points given in <filename>/etc/fstab</filename>, mount points created or
changed with <command>mount</command> are not persistent. They disappear
immediately after the last process of the current user exited. Please see
- <xref linkend="mount-table"/> for more information on the concepts behind
+ <xref linkend="mount-table"/> in the Cygwin User's Guide for more
+ information on the concepts behind
the Cygwin POSIX file system and strategies for using mounts. To remove
mounts temporarily, use <command>umount</command></para>
@@ -1144,22 +1146,22 @@ D: on /d type fat (binary,user,noumount)
implement real POSIX permissions (default).
binary - Files default to binary mode (default).
bind - Allows to remount part of the file hierarchy somewhere else.
- Different from other mount calls, the first argument
- specifies an absolute POSIX path, rather than a Win32 path.
- This POSIX path is remounted to the POSIX path specified as
- the second parameter. The conversion to a Win32 path is done
- within Cygwin immediately at the time of the call. Note that
- symlinks are ignored while performing this path conversion.
+ Different from other mount calls, the first argument
+ specifies an absolute POSIX path, rather than a Win32 path.
+ This POSIX path is remounted to the POSIX path specified as
+ the second parameter. The conversion to a Win32 path is done
+ within Cygwin immediately at the time of the call. Note that
+ symlinks are ignored while performing this path conversion.
cygexec - Treat all files below mount point as cygwin executables.
dos - Always convert leading spaces and trailing dots and spaces to
- characters in the UNICODE private use area. This allows to use
- broken filesystems which only allow DOS filenames, even if they
- are not recognized as such by Cygwin.
+ characters in the UNICODE private use area. This allows to use
+ broken filesystems which only allow DOS filenames, even if they
+ are not recognized as such by Cygwin.
exec - Treat all files below mount point as executable.
ihash - Always fake inode numbers rather than using the ones returned
- by the filesystem. This allows to use broken filesystems which
- don't return unambiguous inode numbers, even if they are not
- recognized as such by Cygwin.
+ by the filesystem. This allows to use broken filesystems which
+ don't return unambiguous inode numbers, even if they are not
+ recognized as such by Cygwin.
noacl - Ignore ACLs and fake POSIX permissions.
nosuid - No suid files are allowed (currently unimplemented)
notexec - Treat all files below mount point as not executable.
@@ -1168,13 +1170,13 @@ D: on /d type fat (binary,user,noumount)
posix=1 - Switch on case sensitivity for paths under this mount point
(default).
sparse - Switch on support for sparse files. This option only makes
- sense on NTFS and then only if you really need sparse files.
+ sense on NTFS and then only if you really need sparse files.
text - Files default to CRLF text mode line endings.
</screen>
<para>For a more complete description of the mount options and the
<filename>/etc/fstab</filename> file, see <xref linkend="mount-table"
- />.</para>
+ />in the Cygwin User's Guide.</para>
<para>Note that all mount points added with <command>mount</command> are
user mount points. System mount points can only be specified in the
@@ -1336,7 +1338,7 @@ Other options:
If no option is given, change USER's password. If no user name is given,
operate on current user. System operations must not be mixed with user
-operations. Don't specify a USER when triggering a system operation.
+operations. Don't specify a USER when triggering a system operation.
Don't specify a user or any other option together with the -R option.
Non-Admin users can only store their password if cygserver is running.
@@ -1424,7 +1426,7 @@ specifying an empty password.
with public key authentication and get a full qualified user token with
all credentials for network access. However, the method has some
drawbacks security-wise. This is explained in more detail in <xref
- linkend="ntsec"/>.</para>
+ linkend="ntsec"/> in the Cygwin User's Guide.</para>
<para>Please note that storing passwords in that registry area is a
privileged operation which only administrative accounts are allowed to
@@ -1590,7 +1592,7 @@ remote host in either \\hostname or hostname: format and prefix is any of:
You can use forward slash ('/') as a separator instead of backslash, in
that case backslash is treated as escape character
-Example: regtool.exe get '\user\software\Microsoft\Clock\iFormat'
+Example: regtool get '\user\software\Microsoft\Clock\iFormat'
</screen>
<para>The <command>regtool</command> program allows shell scripts to access
@@ -1706,7 +1708,7 @@ Modify file and directory access control lists (ACLs)
-f, --file set ACL entries for FILE to ACL entries read
from a ACL_FILE
-k, --remove-default
- remove all default ACL entries
+ remove all default ACL entries
-m, --modify modify one or more specified ACL entries
-r, --replace replace mask entry with maximum permissions
needed for the file group class
@@ -1759,7 +1761,7 @@ At least one of (-b, -d, -f, -k, -m, -s) must be specified
<screen>
u[ser]:uid[:]
g[roup]:gid[:]
- m[ask][:]
+ m[ask][:]
d[efault]:u[ser][:uid]
d[efault]:g[roup][:gid]
d[efault]:m[ask][:]
@@ -1995,8 +1997,8 @@ $ ssp <literal>-v</literal> <literal>-s</literal> <literal>-l</literal> <literal
<title>strace</title>
<screen>
-Usage: strace.exe [OPTIONS] <command-line>
-Usage: strace.exe [OPTIONS] -p <pid>
+Usage: strace [OPTIONS] <command-line>
+Usage: strace [OPTIONS] -p <pid>
Trace system calls and signals
@@ -2013,7 +2015,7 @@ Trace system calls and signals
-q, --quiet toggle "quiet" flag. Defaults to on if "-p",
off otherwise.
-S, --flush-period=PERIOD flush buffered strace output every PERIOD secs
- -t, --timestamp use an absolute hh:mm:ss timestamp insted of
+ -t, --timestamp use an absolute hh:mm:ss timestamp insted of
the default microsecond timestamp. Implies -d
-T, --toggle toggle tracing in a process already being
traced. Requires -p <pid>
@@ -2034,7 +2036,7 @@ Trace system calls and signals
uhoh 0x000008 (_STRACE_UHOH) Unusual or weird phenomenon.
syscall 0x000010 (_STRACE_SYSCALL) System calls.
startup 0x000020 (_STRACE_STARTUP) argc/envp printout at startup.
- debug 0x000040 (_STRACE_DEBUG) Info to help debugging.
+ debug 0x000040 (_STRACE_DEBUG) Info to help debugging.
paranoid 0x000080 (_STRACE_PARANOID) Paranoid info.
termios 0x000100 (_STRACE_TERMIOS) Info for debugging termios stuff.
select 0x000200 (_STRACE_SELECT) Info on ugly select internals.
@@ -2103,7 +2105,7 @@ In csh-compatible shells like tcsh:
<title>umount</title>
<screen>
-Usage: umount.exe [OPTION] [<posixpath>]
+Usage: umount [OPTION] [<posixpath>]
Unmount filesystems
@@ -2119,8 +2121,8 @@ Unmount filesystems
user mount points. The <literal>-U</literal> flag may be used to specify
removing all user mount points from the current user session.</para>
- <para>See <xref linkend="mount-table"/> for more information on the mount
- table.</para>
+ <para>See <xref linkend="mount-table"/> in the Cygwin User's Guide for more
+ information on the mount table.</para>
</sect2>
</sect1>
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
` (5 preceding siblings ...)
2015-06-15 12:37 ` [PATCH 8/8] winsup/doc: Fix an issue with parallel make Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:05 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY Jon TURNEY
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
fo.xsl doesn't seem to be used since c2f50c40 switched back from xsltproc to
xmlto
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (cygwin-ug-net/cygwin-ug-net.pdf)
(cygwin-api/cygwin-api.pdf): Use fo.xsl to customized DocBook
XML->PDF conversion.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 6 ++++++
winsup/doc/Makefile.in | 4 ++--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index 46a7908..a73326a 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,11 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * Makefile.in (cygwin-ug-net/cygwin-ug-net.pdf)
+ (cygwin-api/cygwin-api.pdf): Use fo.xsl to customized DocBook
+ XML->PDF conversion.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* cygwin-ug-net.xml: Remove incorrect unused date.
* utils.xml : Remove .exe suffix inconsistently added in a few
places. Consistently refer to cross-references outside this file
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index a97545c..2d71728 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -80,13 +80,13 @@ cygwin-ug-net/cygwin-ug-net.html : cygwin-ug-net.xml cygwin.xsl
-$(XMLTO) html -o cygwin-ug-net/ -m $(srcdir)/cygwin.xsl $<
cygwin-ug-net/cygwin-ug-net.pdf : cygwin-ug-net.xml fo.xsl
- -$(XMLTO) pdf -o cygwin-ug-net/ $<
+ -$(XMLTO) pdf -o cygwin-ug-net/ -m $(srcdir)/fo.xsl $<
cygwin-api/cygwin-api.html : cygwin-api.xml cygwin.xsl
-$(XMLTO) html -o cygwin-api/ -m $(srcdir)/cygwin.xsl $<
cygwin-api/cygwin-api.pdf : cygwin-api.xml fo.xsl
- -$(XMLTO) pdf -o cygwin-api/ $<
+ -$(XMLTO) pdf -o cygwin-api/ -m $(srcdir)/fo.xsl $<
faq/faq.html : $(FAQ_SOURCES)
-$(XMLTO) html -o faq -m $(srcdir)/cygwin.xsl $(srcdir)/faq.xml
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
` (6 preceding siblings ...)
2015-06-15 12:37 ` [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 16:52 ` Corinna Vinschen
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Left over after 4885352e.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (.PHONY): Remove tarball target.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 4 ++++
winsup/doc/Makefile.in | 2 +-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index 05d78a8..aa45e3d 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,3 +1,7 @@
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
+ * Makefile.in (.PHONY): Remove tarball target.
+
2015-06-04 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in: Remove ancient unused rules to make a documentation
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index 396d9bc..a97545c 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -36,7 +36,7 @@ FAQ_SOURCES:= $(wildcard $(srcdir)/faq*.xml)
.html.body:
$(srcdir)/bodysnatcher.pl $<
-.PHONY: all clean install install-all install-pdf install-html tarball
+.PHONY: all clean install install-all install-pdf install-html
all: Makefile Makefile.dep \
cygwin-ug-net/cygwin-ug-net.html \
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
2015-06-15 12:37 ` [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames Jon TURNEY
2015-06-15 12:37 ` [PATCH 7/8] winsup/doc: Make and install manpages for utils Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:11 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 3/8] winsup/doc: Some preparatory XML fixes Jon TURNEY
` (4 subsequent siblings)
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Convert utils.xml from using a sect2 to using a refentry for each utility
program.
Unfortunately, using refentry seems to tickle a bug in dblatex when generating
pdf, which appears to not escape \ properly in the latex for refentry, so use
fop instead.
Note that the chunked html now generates a page for each utility, rather than
one containing all utilities.
A small customization to TOC generation for HTML and PDF is needed to ensure
that it appears as before, containing an entry for each utility command.
Future work: synopsis and options sections could use more detailed markup than
just wrapping the whole thing in <screen>
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (XMLTO): Switch from dblatex to fop.
* utils.xml : Convert from using a sect2 to using a refentry for
each utility program.
* cygwin.xsl: Customize autotoc to include refentries.
* fo.xsl: Ditto.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 8 +
winsup/doc/Makefile.in | 2 +-
winsup/doc/cygwin.xsl | 13 +
winsup/doc/fo.xsl | 36 +++
winsup/doc/utils.xml | 778 ++++++++++++++++++++++++++++++++++++-------------
5 files changed, 627 insertions(+), 210 deletions(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index a73326a..7b15a5d 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,13 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * Makefile.in (XMLTO): Switch from dblatex to fop.
+ * utils.xml : Convert from using a sect2 to using a refentry for
+ each utility program.
+ * cygwin.xsl: Customize autotoc to include refentries.
+ * fo.xsl: Ditto.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* Makefile.in (cygwin-ug-net/cygwin-ug-net.pdf)
(cygwin-api/cygwin-api.pdf): Use fo.xsl to customized DocBook
XML->PDF conversion.
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index 2d71728..bcc32e4 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -25,7 +25,7 @@ MKDIRP:=$(INSTALL) -m 755 -d
CC:=@CC@
CC_FOR_TARGET:=@CC@
-XMLTO:=xmlto --skip-validation --with-dblatex
+XMLTO:=xmlto --skip-validation --with-fop
include $(srcdir)/../Makefile.common
diff --git a/winsup/doc/cygwin.xsl b/winsup/doc/cygwin.xsl
index 99ec5d0..df12555 100644
--- a/winsup/doc/cygwin.xsl
+++ b/winsup/doc/cygwin.xsl
@@ -10,4 +10,17 @@
<xsl:param name="root.filename" select="@id" />
<xsl:param name="toc.section.depth" select="4" />
+<!-- autotoc.xsl customization to make refentry in sect1 appear in toc -->
+<xsl:template match="sect1" mode="toc">
+ <xsl:param name="toc-context" select="."/>
+ <xsl:call-template name="subtoc">
+ <xsl:with-param name="toc-context" select="$toc-context"/>
+ <xsl:with-param name="nodes" select="sect2|refentry
+ |bridgehead[$bridgehead.in.toc != 0]"/>
+ </xsl:call-template>
+</xsl:template>
+
+<!-- suppress refentry in toc being annotated with refpurpose -->
+<xsl:param name="annotate.toc" select="0" />
+
</xsl:stylesheet>
diff --git a/winsup/doc/fo.xsl b/winsup/doc/fo.xsl
index 4bc255c..ba8e191 100644
--- a/winsup/doc/fo.xsl
+++ b/winsup/doc/fo.xsl
@@ -29,4 +29,40 @@
<!-- Inform the DocBook stylesheets that it's safe to use FOP
specific extensions. -->
<xsl:param name="fop1.extensions" select="1"/>
+
+ <!-- autotoc.xsl customization to make refentry in sect1 appear in toc -->
+<xsl:template match="sect1" mode="toc">
+ <xsl:param name="toc-context" select="."/>
+
+ <xsl:variable name="id">
+ <xsl:call-template name="object.id"/>
+ </xsl:variable>
+
+ <xsl:variable name="cid">
+ <xsl:call-template name="object.id">
+ <xsl:with-param name="object" select="$toc-context"/>
+ </xsl:call-template>
+ </xsl:variable>
+
+ <xsl:call-template name="toc.line">
+ <xsl:with-param name="toc-context" select="$toc-context"/>
+ </xsl:call-template>
+
+ <xsl:variable name="depth.from.context" select="count(ancestor::*)-count($toc-context/ancestor::*)"/>
+
+ <xsl:if test="$toc.section.depth > 1
+ and $toc.max.depth > $depth.from.context">
+ <fo:block id="toc.{$cid}.{$id}">
+ <xsl:attribute name="margin-{$direction.align.start}">
+ <xsl:call-template name="set.toc.indent"/>
+ </xsl:attribute>
+
+ <xsl:apply-templates select="refentry|sect2|qandaset[$qanda.in.toc != 0]"
+ mode="toc">
+ <xsl:with-param name="toc-context" select="$toc-context"/>
+ </xsl:apply-templates>
+ </fo:block>
+ </xsl:if>
+</xsl:template>
+
</xsl:stylesheet>
diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index fcecd11..a3d7da8 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -13,10 +13,20 @@
identically. All of the Cygwin command-line utilities support the
<literal>--help</literal> and <literal>--version</literal> options. </para>
- <sect2 id="cygcheck">
- <title>cygcheck</title>
-
- <screen>
+ <refentry id="cygcheck">
+ <refmeta>
+ <refentrytitle>cygcheck</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>cygcheck</refname>
+ <refpurpose>List system information, check installed packages, or query package database</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: cygcheck [-v] [-h] PROGRAM
cygcheck -c [-d] [PACKAGE]
cygcheck -s [-r] [-v] [-h]
@@ -29,9 +39,12 @@ Usage: cygcheck [-v] [-h] PROGRAM
cygcheck --disable-unique-object-names Cygwin-DLL
cygcheck --show-unique-object-names Cygwin-DLL
cygcheck -h
+ </screen>
+ </refsynopsisdiv>
-List system information, check installed packages, or query package database.
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
At least one command option or a PROGRAM is required, as shown above.
PROGRAM list library (DLL) dependencies of PROGRAM
@@ -68,7 +81,10 @@ Note: -c, -f, and -l only report on packages that are currently installed. To
search all official Cygwin packages use -p instead. The -p REGEXP matches
package names, descriptions, and names of files/paths within all packages.
</screen>
+ </refsect1>
+<refsect1>
+ <title>Description</title>
<para> The <command>cygcheck</command> program is a diagnostic utility for
dealing with Cygwin programs. If you are familiar with
<command>dpkg</command> or <command>rpm</command>,
@@ -257,20 +273,34 @@ are unable to find another Cygwin DLL.
and <literal>--enable-...</literal> options, the
<literal>--show-unique-object-names</literal> option also works for
Cygwin DLLs which are currently in use.</para>
+ </refsect1>
- </sect2>
+ </refentry>
- <sect2 id="cygpath">
- <title>cygpath</title>
+ <refentry id="cygpath">
+ <refmeta>
+ <refentrytitle>cygpath</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>cygpath</refname>
+ <refpurpose>Convert Unix and Windows format paths, or output system path information</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
<screen>
Usage: cygpath (-d|-m|-u|-w|-t TYPE) [-f FILE] [OPTION]... NAME...
cygpath [-c HANDLE]
cygpath [-ADHOPSW]
cygpath [-F ID]
+ </screen>
+ </refsynopsisdiv>
-Convert Unix and Windows format paths, or output system path information
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
Output type options:
-d, --dos print DOS (short) form of NAMEs (C:\PROGRA~1\)
@@ -312,7 +342,10 @@ Other options:
-h, --help output usage information and exit
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>cygpath</command> program is a utility that converts
Windows native filenames to Cygwin POSIX-style pathnames and vice versa.
It can be used when a Cygwin program needs to pass a file name to a
@@ -417,23 +450,39 @@ explorer $XPATH &
(CDBurn area). By default the output is in UNIX (POSIX) format; use the
<literal>-w</literal> or <literal>-d</literal> options to get other
formats.</para>
-
- </sect2>
-
- <sect2 id="dumper">
- <title>dumper</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="dumper">
+ <refmeta>
+ <refentrytitle>dumper</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>dumper</refname>
+ <refpurpose>Dump core from WIN32PID to FILENAME.core</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: dumper [OPTION] FILENAME WIN32PID
+ </screen>
+ </refsynopsisdiv>
-Dump core from WIN32PID to FILENAME.core
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-d, --verbose be verbose while dumping
-h, --help output help information and exit
-q, --quiet be quiet while dumping (default)
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>dumper</command> utility can be used to create a core
dump of running Windows process. This core dump can be later loaded to
<command>gdb</command> and analyzed. One common way to use
@@ -461,18 +510,31 @@ error_start=x:\path\to\dumper.exe
dump on one machine and try to debug it on another, you'll need to place
identical copies of the executable and dlls in the same directories as on
the machine where the core dump was created. </para>
-
- </sect2>
-
- <sect2 id="getconf">
- <title>getconf</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="getconf">
+ <refmeta>
+ <refentrytitle>getconf</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>getconf</refname>
+ <refpurpose>Get configuration values</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: getconf [-v specification] variable_name [pathname]
getconf -a [pathname]
+ </screen>
+ </refsynopsisdiv>
-Get configuration values
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-v specification Indicate specific version for which configuration
values shall be fetched.
-a, --all Print all known configuration values
@@ -482,7 +544,10 @@ Other options:
-h, --help This text
-V, --version Print program version and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>getconf</command> utility prints the value of the
configuration variable specified by <literal>variable_name</literal>. If
no <literal>pathname</literal> is given, <command>getconf</command>
@@ -509,17 +574,30 @@ Other options:
<para>Use the <literal>-a</literal> option to print a list of all available
configuration variables for the system, or given
<literal>pathname</literal>, and their values.</para>
-
- </sect2>
-
- <sect2 id="getfacl">
- <title>getfacl</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="getfacl">
+ <refmeta>
+ <refentrytitle>getfacl</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>getfacl</refname>
+ <refpurpose>Display file and directory access control lists (ACLs)</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: getfacl [-adn] FILE [FILE2...]
+ </screen>
+ </refsynopsisdiv>
-Display file and directory access control lists (ACLs).
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-a, --access display the file access control list
-d, --default display the default access control list
-h, --help print help explaining the command line options
@@ -529,7 +607,10 @@ Display file and directory access control lists (ACLs).
When multiple files are specified on the command line, a blank
line separates the ACLs for each file.
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para> For each argument that is a regular file, special file or directory,
<command>getfacl</command> displays the owner, the group, and the ACL.
For directories <command>getfacl</command> displays additionally the
@@ -558,24 +639,41 @@ line separates the ACLs for each file.
default:other:perm
</screen>
</para>
- </sect2>
-
- <sect2 id="kill">
- <title>kill</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="kill">
+ <refmeta>
+ <refentrytitle>kill</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>kill</refname>
+ <refpurpose>Send signals to processes</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: kill [-f] [-signal] [-s signal] pid1 [pid2 ...]
kill -l [signal]
+ </screen>
+ </refsynopsisdiv>
-Send signals to processes
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-f, --force force, using win32 interface if necessary
-l, --list print a list of signal names
-s, --signal send signal (use kill --list for a list)
-h, --help output usage information and exit
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>kill</command> program allows you to send arbitrary
signals to other Cygwin programs. The usual purpose is to end a running
program from some other window when ^C won't work, but you can also send
@@ -658,17 +756,30 @@ SIGPWR 29 power failure
SIGUSR1 30 user defined signal 1
SIGUSR2 31 user defined signal 2
</screen>
-
- </sect2>
-
- <sect2 id="ldd">
- <title>ldd</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="ldd">
+ <refmeta>
+ <refentrytitle>ldd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>ldd</refname>
+ <refpurpose>Print shared library dependencies</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: ldd [OPTION]... FILE...
+ </screen>
+ </refsynopsisdiv>
-Print shared library dependencies
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-h, --help print this help and exit
-V, --version print version information and exit
-r, --function-relocs process data and function relocations
@@ -678,23 +789,39 @@ Print shared library dependencies
-v, --verbose print all information
(currently unimplemented)
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para><command>ldd</command> prints the shared libraries (DLLs) an
executable or DLL is linked against. No modifying option is implemented
yet.</para>
-
- </sect2>
-
- <sect2 id="locale">
- <title>locale</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="locale">
+ <refmeta>
+ <refentrytitle>locale</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>locale</refname>
+ <refpurpose>Get locale-specific information</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: locale [-amvhV]
or: locale [-ck] NAME
or: locale [-usfnU]
+ </screen>
+ </refsynopsisdiv>
-Get locale-specific information.
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
System information:
-a, --all-locales List all available supported locales
@@ -720,7 +847,10 @@ Other options:
-h, --help This text
-V, --version Print program version and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para><command>locale</command> without parameters prints information about
the current locale environment settings.</para>
@@ -830,17 +960,31 @@ nostr="no"
messages-codeset="UTF-8"
bash$ locale noexpr
^[nN]
-</screen>
-
- </sect2>
-
- <sect2 id="minidumper"><title>minidumper</title>
-
- <screen>
+ </screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="minidumper">
+ <refmeta>
+ <refentrytitle>minidumper</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>minidumper</refname>
+ <refpurpose>Write minidump from WIN32PID to FILENAME.dmp</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: minidumper [OPTION] FILENAME WIN32PID
+ </screen>
+ </refsynopsisdiv>
-Write minidump from WIN32PID to FILENAME.dmp
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-t, --type minidump type flags
-n, --nokill don't terminate the dumped process
-d, --verbose be verbose while dumping
@@ -848,7 +992,10 @@ Write minidump from WIN32PID to FILENAME.dmp
-q, --quiet be quiet while dumping (default)
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>
The <command>minidumper</command> utility can be used to create a
minidump of a running Windows process. This minidump can be later
@@ -867,20 +1014,30 @@ Write minidump from WIN32PID to FILENAME.dmp
<command>dumper</command> the target process is terminated after dumping
unless the <literal>-n</literal> option is given.
</para>
-
- </sect2>
-
- <sect2 id="mkgroup">
- <title>mkgroup</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="mkgroup">
+ <refmeta>
+ <refentrytitle>mkgroup</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mkgroup</refname>
+ <refpurpose>Write /etc/group-like output to stdout</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: mkgroup [OPTION]...
+ </screen>
+ </refsynopsisdiv>
-Write /etc/group-like output to stdout
-
-Don't use this command to generate a local /etc/group file, unless you
-really need one. See the Cygwin User's Guide for more information.
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
Options:
-l,--local [machine] Print local group accounts of \"machine\",
@@ -907,6 +1064,13 @@ Options:
Default is to print local groups on stand-alone machines, plus domain
groups on domain controllers and domain member machines.
</screen>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+ <para>Don't use this command to generate a local /etc/group file, unless you
+ really need one. See the Cygwin User's Guide for more information.
+ </para>
<para>The <command>mkgroup</command> program can be used to create a local
<filename>/etc/group</filename> file. Cygwin doesn't need this file,
@@ -954,21 +1118,31 @@ groups on domain controllers and domain member machines.
samba-server</literal> or <literal>-L samba-server</literal>. The normal
UNIX groups are usually not enumerated, but they can show up as a group
in <command>ls -l</command> output. </para>
-
- </sect2>
-
- <sect2 id="mkpasswd">
- <title>mkpasswd</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="mkpasswd">
+ <refmeta>
+ <refentrytitle>mkpasswd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mkpasswd</refname>
+ <refpurpose>Write /etc/passwd-like output to stdout</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: mkpasswd [OPTIONS]...
+ </screen>
+ </refsynopsisdiv>
-Write /etc/passwd-like output to stdout
-
-Don't use this command to generate a local /etc/passwd file, unless you
-really need one. See the Cygwin User's Guide for more information.
-
-Options:
+ <refsect1>
+ <title>Options</title>
+ <screen>
+ Options:
-l,--local [machine] Print local user accounts of \"machine\",
from local machine if no machine specified.
@@ -997,6 +1171,12 @@ Options:
Default is to print local accounts on stand-alone machines, domain accounts
on domain controllers and domain member machines.
</screen>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+ <para>Don't use this command to generate a local /etc/passwd file, unless you
+ really need one. See the Cygwin User's Guide for more information.</para>
<para>The <command>mkpasswd</command> program can be used to create a
<filename>/etc/passwd</filename> file. Cygwin doesn't need this file,
@@ -1044,19 +1224,32 @@ on domain controllers and domain member machines.
samba-server</literal>. The normal UNIX users are usually not enumerated,
but they can show up as file owners in <command>ls -l</command> output.
</para>
-
- </sect2>
-
- <sect2 id="mount">
- <title>mount</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="mount">
+ <refmeta>
+ <refentrytitle>mount</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mount</refname>
+ <refpurpose>Display information about mounted filesystems, or mount a filesystem</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: mount [OPTION] [<win32path> <posixpath>]
mount -a
mount <posixpath>
+ </screen>
+ </refsynopsisdiv>
-Display information about mounted filesystems, or mount a filesystem
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-a, --all mount all filesystems mentioned in fstab
-c, --change-cygdrive-prefix change the cygdrive path prefix to <posixpath>
-f, --force force mount, don't warn about missing mount
@@ -1068,7 +1261,10 @@ Display information about mounted filesystems, or mount a filesystem
-p, --show-cygdrive-prefix show user and/or system cygdrive path prefix
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>mount</command> program is used to map your drives and
shares onto Cygwin's simulated POSIX directory tree, much like as is done
by mount commands on typical UNIX systems. However, in contrast to mount
@@ -1080,7 +1276,7 @@ Display information about mounted filesystems, or mount a filesystem
the Cygwin POSIX file system and strategies for using mounts. To remove
mounts temporarily, use <command>umount</command></para>
- <sect3 id="utils-mount">
+ <refsect2 id="utils-mount">
<title>Using mount</title>
<para>If you just type <command>mount</command> with no parameters, it
@@ -1225,9 +1421,9 @@ D: on /d type fat (binary,user,noumount)
<filename>/etc/fstab</filename> to restore the old state. It also makes
moving your settings to a different machine much easier.</para>
- </sect3>
+ </refsect2>
- <sect3 id="utils-cygdrive">
+ <refsect2 id="utils-cygdrive">
<title>Cygdrive mount points</title>
<para>Whenever Cygwin cannot use any of the existing mounts to convert
@@ -1266,9 +1462,9 @@ D: on /d type fat (binary,user,noumount)
</example>
- </sect3>
+ </refsect2>
- <sect3 id="utils-limitations">
+ <refsect2 id="utils-limitations">
<title>Limitations</title>
<para>Limitations: there is a hard-coded limit of 64 mount points (up to
@@ -1295,18 +1491,31 @@ D: on /d type fat (binary,user,noumount)
or <command>echo *</command> command and <command>find .</command> will
not find <filename>mtpt</filename>. </para>
- </sect3>
+ </refsect2>
+ </refsect1>
+ </refentry>
- </sect2>
+ <refentry id="passwd">
+ <refmeta>
+ <refentrytitle>passwd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
- <sect2 id="passwd">
- <title>passwd</title>
+ <refnamediv>
+ <refname>passwd</refname>
+ <refpurpose>Change USER's password or password attributes.</refpurpose>
+ </refnamediv>
- <screen>
+ <refsynopsisdiv>
+ <screen>
Usage: passwd [OPTION] [USER]
+ </screen>
+ </refsynopsisdiv>
-Change USER's password or password attributes.
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
User operations:
-l, --lock lock USER's account.
-u, --unlock unlock USER's account.
@@ -1348,7 +1557,10 @@ Don't use this feature if you don't need network access within a remote
session. You can delete your stored password by using `passwd -R' and
specifying an empty password.
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para> <command>passwd</command> changes passwords for user accounts. A
normal user may only change the password for their own account, but
administrators may change passwords on any account.
@@ -1441,35 +1653,64 @@ specifying an empty password.
<para>Limitations: Users may not be able to change their password on some
systems.</para>
-
- </sect2>
-
- <sect2 id="pldd">
- <title>pldd</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="pldd">
+ <refmeta>
+ <refentrytitle>pldd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pldd</refname>
+ <refpurpose>List dynamic shared objects loaded into a process</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: pldd [OPTION...] PID
+ </screen>
+ </refsynopsisdiv>
-List dynamic shared objects loaded into a process.
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-?, --help Give this help list
--usage Give a short usage message
-V, --version Print program version
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para><command>pldd</command> prints the shared libraries (DLLs) loaded by
the process with the given PID.</para>
-
- </sect2>
-
- <sect2 id="ps">
- <title>ps</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="ps">
+ <refmeta>
+ <refentrytitle>ps</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>ps</refname>
+ <refpurpose>Report process status</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: ps [-aefls] [-u UID]
+ </screen>
+ </refsynopsisdiv>
-Report process status
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-a, --all show processes of all users
-e, --everyone show processes of all users
-f, --full show process uids, ppids
@@ -1482,7 +1723,10 @@ Report process status
-W, --windows show windows as well as cygwin processes
With no options, ps outputs the long format by default
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>ps</command> program gives the status of all the Cygwin
processes running on the system (ps = "process status"). Due to the
limitations of simulating a POSIX environment under Windows, there is
@@ -1516,17 +1760,30 @@ With no options, ps outputs the long format by default
non-Cygwin Windows processes as well as Cygwin processes. The WINPID is
also the PID, and they can be killed with the Cygwin
<command>kill</command> command's <literal>-f</literal> option. </para>
-
- </sect2>
-
- <sect2 id="regtool">
- <title>regtool</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="regtool">
+ <refmeta>
+ <refentrytitle>regtool</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>regtool</refname>
+ <refpurpose>View or edit the Windows registry</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: regtool [OPTION] (add|check|get|list|remove|unset|load|unload|save) KEY
+ </screen>
+ </refsynopsisdiv>
-View or edit the Win32 registry
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
Actions:
add KEY\SUBKEY add new SUBKEY
@@ -1594,7 +1851,10 @@ You can use forward slash ('/') as a separator instead of backslash, in
that case backslash is treated as escape character
Example: regtool get '\user\software\Microsoft\Clock\iFormat'
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>regtool</command> program allows shell scripts to access
and modify the Windows registry. Note that modifying the Windows registry
is dangerous, and carelessness here can result in an unusable system. Be
@@ -1690,19 +1950,31 @@ Example: regtool get '\user\software\Microsoft\Clock\iFormat'
<para> By default, the last "\" or "/" is assumed to be the separator
between the key and the value. You can use the <literal>-K</literal>
option to provide an alternate key/value separator character. </para>
-
- </sect2>
-
- <sect2 id="setfacl">
- <title>setfacl</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="setfacl">
+ <refmeta>
+ <refentrytitle>setfacl</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>setfacl</refname>
+ <refpurpose>Modify file and directory access control lists (ACLs)</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: setfacl [-r] {-f ACL_FILE | -s acl_entries} FILE...
setfacl [-r] {-b|[-d acl_entries] [-m acl_entries]} FILE...
+ </screen>
+ </refsynopsisdiv>
-
-Modify file and directory access control lists (ACLs)
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-b, --remove-all remove all extended ACL entries
-d, --delete delete one or more specified ACL entries
-f, --file set ACL entries for FILE to ACL entries read
@@ -1719,7 +1991,10 @@ Modify file and directory access control lists (ACLs)
At least one of (-b, -d, -f, -k, -m, -s) must be specified
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para> For each file given as parameter, <command>setfacl</command> will
either replace its complete ACL (<literal>-s</literal>,
<literal>-f</literal>), or it will add, modify, or delete ACL entries.
@@ -1811,17 +2086,32 @@ $ getfacl source_file | setfacl -f - target_file
directory that contains default ACL entries will have permissions
according to the combination of the current umask, the explicit
permissions requested and the default ACL entries </para>
- </sect2>
-
- <sect2 id="setmetamode">
- <title>setmetamode</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="setmetamode">
+ <refmeta>
+ <refentrytitle>setmetamode</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>setmetamode</refname>
+ <refpurpose>Get or set keyboard meta mode</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: setmetamode [metabit|escprefix]
+ </screen>
+ </refsynopsisdiv>
-Get or set keyboard meta mode
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
Without argument, it shows the current meta key mode.
+
metabit|meta|bit The meta key sets the top bit of the character.
escprefix|esc|prefix The meta key sends an escape prefix.
@@ -1830,20 +2120,36 @@ Other options:
-h, --help This text
-V, --version Print program version and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para><command>setmetamode</command> can be used to determine and set the
key code sent by the meta (aka <literal>Alt</literal>) key.</para>
-
- </sect2>
-
- <sect2 id="ssp">
- <title>ssp</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="ssp">
+ <refmeta>
+ <refentrytitle>ssp</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>ssp</refname>
+ <refpurpose>Single-step profile COMMAND</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: ssp [options] low_pc high_pc command...
+ </screen>
+ </refsynopsisdiv>
-Single-step profile COMMAND
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-c, --console-trace trace every EIP value to the console. *Lots* slower.
-d, --disable disable single-stepping by default; use
OutputDebugString ("ssp on") to enable stepping
@@ -1861,7 +2167,10 @@ Single-step profile COMMAND
Example: ssp 0x401000 0x403000 hello.exe
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para> SSP - The Single Step Profiler </para>
<para> Original Author: DJ Delorie </para>
@@ -1991,17 +2300,31 @@ Each sample counts as 0.01 seconds.
$ ssp <literal>-v</literal> <literal>-s</literal> <literal>-l</literal> <literal>-d</literal> 0x61001000 0x61080000 hello.exe
</screen>
</para>
- </sect2>
-
- <sect2 id="strace">
- <title>strace</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="strace">
+ <refmeta>
+ <refentrytitle>strace</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>strace</refname>
+ <refpurpose>Trace system calls and signals</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: strace [OPTIONS] <command-line>
Usage: strace [OPTIONS] -p <pid>
+ </screen>
+ </refsynopsisdiv>
-Trace system calls and signals
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-b, --buffer-size=SIZE set size of output file buffer
-d, --no-delta don't display the delta-t microsecond timestamp
-e, --events log all Windows DEBUG_EVENTS (toggle - default true)
@@ -2052,7 +2375,10 @@ Trace system calls and signals
special 0x100000 (_STRACE_SPECIAL) Special debugging printfs for
non-checked-in code
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>strace</command> program executes a program, and
optionally the children of the program, reporting any Cygwin DLL output
from the program(s) to stdout, or to a file with the
@@ -2069,51 +2395,84 @@ $ strace -o tracing_output -w sh -c 'while true; do echo "tracing..."; done' &am
<command>cygcheck</command>). As a result it does not understand
symlinks. This program is mainly useful for debugging the Cygwin DLL
itself.</para>
-
- </sect2>
-
- <sect2 id="tzset">
- <title>tzset</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="tzset">
+ <refmeta>
+ <refentrytitle>tzset</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>tzset</refname>
+ <refpurpose>Print POSIX-compatible timezone ID from current Windows timezone setting</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: tzset [OPTION]
+ </screen>
+ </refsynopsisdiv>
-Print POSIX-compatible timezone ID from current Windows timezone setting
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
Options:
-h, --help output usage information and exit.
-V, --version output version information and exit.
+ </screen>
+ </refsect1>
-Use tzset to set your TZ variable. In POSIX-compatible shells like bash,
-dash, mksh, or zsh:
-
- export TZ=$(tzset)
-
-In csh-compatible shells like tcsh:
-
- setenv TZ `tzset`
-</screen>
+ <refsect1>
+ <title>Description</title>
+ Use tzset to set your TZ variable. In POSIX-compatible shells like bash,
+ dash, mksh, or zsh:
+ <screen>
+export TZ=$(tzset)
+ </screen>
+ In csh-compatible shells like tcsh:
+ <screen>
+setenv TZ `tzset`
+ </screen>
<para>The <command>tzset</command> tool reads the current timezone from
Windows and generates a POSIX-compatible timezone information for the TZ
environment variable from that information. That's all there is to it.
For the way how to use it, see the above usage information.</para>
-
- </sect2>
-
- <sect2 id="umount">
- <title>umount</title>
-
- <screen>
+ </refsect1>
+ </refentry>
+
+ <refentry id="umount">
+ <refmeta>
+ <refentrytitle>umount</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>umount</refname>
+ <refpurpose>Unmount filesystems</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <screen>
Usage: umount [OPTION] [<posixpath>]
+ </screen>
+ </refsynopsisdiv>
-Unmount filesystems
-
+ <refsect1>
+ <title>Options</title>
+ <screen>
-h, --help output usage information and exit
-U, --remove-user-mounts remove all user mounts
-V, --version output version information and exit
</screen>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>The <command>umount</command> program removes mounts from the mount
table in the current session. If you specify a POSIX path that
corresponds to a current mount point, <command>umount</command> will
@@ -2123,6 +2482,7 @@ Unmount filesystems
<para>See <xref linkend="mount-table"/> in the Cygwin User's Guide for more
information on the mount table.</para>
- </sect2>
+ </refsect1>
+ </refentry>
</sect1>
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
` (3 preceding siblings ...)
2015-06-15 12:37 ` [PATCH 3/8] winsup/doc: Some preparatory XML fixes Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 17:15 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 8/8] winsup/doc: Fix an issue with parallel make Jon TURNEY
` (2 subsequent siblings)
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Change xidepend to create a variable containing all the XIncluded sources, which
can be used as a dependency, rather than writing the dependency target itself.
Future work: Makefile.dep should depend on xidepend, but xidepend should not be
passed to itself.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* xidepend: Write a Makefile fragment defining variables
containing all the XIncluded sources, rather than a dependency on
those sources.
* Makefile.in: Use that variable to express the dependency.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 7 +++++++
winsup/doc/Makefile.in | 15 +++++++--------
winsup/doc/xidepend | 2 +-
3 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index 7b15a5d..7d33752 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,12 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * xidepend: Write a Makefile fragment defining variables
+ containing all the XIncluded sources, rather than a dependency on
+ those sources.
+ * Makefile.in: Use that variable to express the dependency.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* Makefile.in (XMLTO): Switch from dblatex to fop.
* utils.xml : Convert from using a sect2 to using a refentry for
each utility program.
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index bcc32e4..79a050a 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -28,6 +28,7 @@ CC_FOR_TARGET:=@CC@
XMLTO:=xmlto --skip-validation --with-fop
include $(srcdir)/../Makefile.common
+-include Makefile.dep
FAQ_SOURCES:= $(wildcard $(srcdir)/faq*.xml)
@@ -61,7 +62,7 @@ install-all: install-pdf install-html
install-pdf: cygwin-ug-net/cygwin-ug-net.pdf cygwin-api/cygwin-api.pdf
@$(MKDIRP) $(DESTDIR)$(docdir)
$(INSTALL_DATA) $^ $(DESTDIR)$(docdir)
-
+
install-html: cygwin-ug-net/cygwin-ug-net.html cygwin-api/cygwin-api.html
@$(MKDIRP) $(DESTDIR)$(htmldir)/cygwin-ug-net
$(INSTALL_DATA) cygwin-ug-net/*.html $(DESTDIR)$(htmldir)/cygwin-ug-net
@@ -70,22 +71,22 @@ install-html: cygwin-ug-net/cygwin-ug-net.html cygwin-api/cygwin-api.html
$(INSTALL_DATA) cygwin-api/*.html $(DESTDIR)$(htmldir)/cygwin-api
$(INSTALL_DATA) cygwin-api/cygwin-api.html $(DESTDIR)$(htmldir)/cygwin-api/index.html
-cygwin-ug-net/cygwin-ug-net-nochunks.html.gz : cygwin-ug-net.xml
+cygwin-ug-net/cygwin-ug-net-nochunks.html.gz : $(cygwin-ug-net_SOURCES) cygwin.xsl
-$(XMLTO) html-nochunks -m $(srcdir)/cygwin.xsl $<
-cp cygwin-ug-net.html cygwin-ug-net/cygwin-ug-net-nochunks.html
-rm -f cygwin-ug-net/cygwin-ug-net-nochunks.html.gz
-gzip cygwin-ug-net/cygwin-ug-net-nochunks.html
-cygwin-ug-net/cygwin-ug-net.html : cygwin-ug-net.xml cygwin.xsl
+cygwin-ug-net/cygwin-ug-net.html : $(cygwin-ug-net_SOURCES) cygwin.xsl
-$(XMLTO) html -o cygwin-ug-net/ -m $(srcdir)/cygwin.xsl $<
-cygwin-ug-net/cygwin-ug-net.pdf : cygwin-ug-net.xml fo.xsl
+cygwin-ug-net/cygwin-ug-net.pdf : $(cygwin-ug-net_SOURCES) fo.xsl
-$(XMLTO) pdf -o cygwin-ug-net/ -m $(srcdir)/fo.xsl $<
-cygwin-api/cygwin-api.html : cygwin-api.xml cygwin.xsl
+cygwin-api/cygwin-api.html : $(cygwin-api_SOURCES) cygwin.xsl
-$(XMLTO) html -o cygwin-api/ -m $(srcdir)/cygwin.xsl $<
-cygwin-api/cygwin-api.pdf : cygwin-api.xml fo.xsl
+cygwin-api/cygwin-api.pdf : $(cygwin-api_SOURCES) fo.xsl
-$(XMLTO) pdf -o cygwin-api/ -m $(srcdir)/fo.xsl $<
faq/faq.html : $(FAQ_SOURCES)
@@ -94,5 +95,3 @@ faq/faq.html : $(FAQ_SOURCES)
Makefile.dep: cygwin-ug-net.xml cygwin-api.xml
cd $(srcdir) && ./xidepend $^ > "${CURDIR}/$@"
-
--include Makefile.dep
diff --git a/winsup/doc/xidepend b/winsup/doc/xidepend
index f476620..cc04f4a 100755
--- a/winsup/doc/xidepend
+++ b/winsup/doc/xidepend
@@ -16,7 +16,7 @@ do
then
# This file uses XIncludes. Let's chase its deps recursively.
base=`basename "$f" .xml`
- if [ $subproc -eq 0 ] ; then echo -n "$base/$base.html $base/$base.pdf:" ; fi
+ if [ $subproc -eq 0 ] ; then echo -n "${base}_SOURCES=${f}" ; fi
deps=`grep 'xi:include.*href' "$f" | cut -f2 -d\" | tr '\n' ' '`
echo -n " $deps"
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* [PATCH 7/8] winsup/doc: Make and install manpages for utils
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
2015-06-15 12:37 ` [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames Jon TURNEY
@ 2015-06-15 12:37 ` Jon TURNEY
2015-06-15 18:12 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry Jon TURNEY
` (5 subsequent siblings)
7 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-15 12:37 UTC (permalink / raw)
To: cygwin-patches; +Cc: Jon TURNEY
Use 'xmlto man' to make manpages for utils
(docbook2x-man could also be used, but since we already use xmlto...)
This will generate multiple .1 files as an output, but we don't know what they
will be called, so use a timestamp file for build avoidance when the
dependencies haven't changed.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (install-man, utils2man.stamp): Add rules to build
and install manpages for utils.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
---
winsup/doc/ChangeLog | 5 +++++
winsup/doc/Makefile.in | 18 +++++++++++++++---
2 files changed, 20 insertions(+), 3 deletions(-)
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog
index 7d33752..341374f 100644
--- a/winsup/doc/ChangeLog
+++ b/winsup/doc/ChangeLog
@@ -1,5 +1,10 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+ * Makefile.in (install-man, utils2man.stamp): Add rules to build
+ and install manpages for utils.
+
+2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
+
* xidepend: Write a Makefile fragment defining variables
containing all the XIncluded sources, rather than a dependency on
those sources.
diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in
index 79a050a..bb2ad36 100644
--- a/winsup/doc/Makefile.in
+++ b/winsup/doc/Makefile.in
@@ -16,6 +16,8 @@ prefix:=@prefix@
datarootdir:=@datarootdir@
docdir = @docdir@
htmldir = @htmldir@
+mandir = @mandir@
+man1dir = $(mandir)/man1
override INSTALL:=@INSTALL@
override INSTALL_DATA:=@INSTALL_DATA@
@@ -37,7 +39,7 @@ FAQ_SOURCES:= $(wildcard $(srcdir)/faq*.xml)
.html.body:
$(srcdir)/bodysnatcher.pl $<
-.PHONY: all clean install install-all install-pdf install-html
+.PHONY: all clean install install-all install-pdf install-html install-man
all: Makefile Makefile.dep \
cygwin-ug-net/cygwin-ug-net.html \
@@ -45,7 +47,8 @@ all: Makefile Makefile.dep \
cygwin-api/cygwin-api.html \
faq/faq.body faq/faq.html \
cygwin-ug-net/cygwin-ug-net.pdf \
- cygwin-api/cygwin-api.pdf
+ cygwin-api/cygwin-api.pdf \
+ utils2man.stamp
Makefile: $(srcdir)/Makefile.in
/bin/sh ./config.status
@@ -54,10 +57,11 @@ clean:
rm -f Makefile.dep
rm -f *.html *.html.gz
rm -Rf cygwin-api cygwin-ug cygwin-ug-net faq
+ rm -f *.1 utils2man.stamp
install: install-all
-install-all: install-pdf install-html
+install-all: install-pdf install-html install-man
install-pdf: cygwin-ug-net/cygwin-ug-net.pdf cygwin-api/cygwin-api.pdf
@$(MKDIRP) $(DESTDIR)$(docdir)
@@ -71,6 +75,10 @@ install-html: cygwin-ug-net/cygwin-ug-net.html cygwin-api/cygwin-api.html
$(INSTALL_DATA) cygwin-api/*.html $(DESTDIR)$(htmldir)/cygwin-api
$(INSTALL_DATA) cygwin-api/cygwin-api.html $(DESTDIR)$(htmldir)/cygwin-api/index.html
+install-man: utils2man.stamp
+ @$(MKDIRP) $(DESTDIR)$(man1dir)
+ $(INSTALL_DATA) *.1 $(DESTDIR)$(man1dir)
+
cygwin-ug-net/cygwin-ug-net-nochunks.html.gz : $(cygwin-ug-net_SOURCES) cygwin.xsl
-$(XMLTO) html-nochunks -m $(srcdir)/cygwin.xsl $<
-cp cygwin-ug-net.html cygwin-ug-net/cygwin-ug-net-nochunks.html
@@ -83,6 +91,10 @@ cygwin-ug-net/cygwin-ug-net.html : $(cygwin-ug-net_SOURCES) cygwin.xsl
cygwin-ug-net/cygwin-ug-net.pdf : $(cygwin-ug-net_SOURCES) fo.xsl
-$(XMLTO) pdf -o cygwin-ug-net/ -m $(srcdir)/fo.xsl $<
+utils2man.stamp: $(cygwin-ug-net_SOURCES)
+ $(XMLTO) man $<
+ @touch $@
+
cygwin-api/cygwin-api.html : $(cygwin-api_SOURCES) cygwin.xsl
-$(XMLTO) html -o cygwin-api/ -m $(srcdir)/cygwin.xsl $<
--
2.1.4
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY
2015-06-15 12:37 ` [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY Jon TURNEY
@ 2015-06-15 16:52 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 16:52 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 346 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> Left over after 4885352e.
>
> 2015-06-12 Jon Turney <...>
>
> * Makefile.in (.PHONY): Remove tarball target.
Please apply.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames
2015-06-15 12:37 ` [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames Jon TURNEY
@ 2015-06-15 17:02 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:02 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 1036 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> It seems that xidepend doesn't work correctly if we are ./configure'd using a
> relative pathname to the srcdir:
>
> $ make
> cd ../../../../src/winsup/doc && ./xidepend ../../../../src/winsup/doc/cygwin-ug-net.xml ../../../../src/winsup/doc/cygwin-api.xml >"/wip/cygwin/build/x86_64-unknown-cygwin/winsup/doc/Makefile.dep"
> grep: ../../../../src/winsup/doc/cygwin-ug-net.xml: No such file or directory
> grep: ../../../../src/winsup/doc/cygwin-api.xml: No such file or directory
>
> Although it might be better to fix this by making xidepend use pathnames, rather
> than ignoring them and assuming everything is in the current directory...
Indeed. The problem is the included loop iterating over the
dependencies. A more foolproof solution would be helpful.
For the time being, please apply your patch.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 3/8] winsup/doc: Some preparatory XML fixes
2015-06-15 12:37 ` [PATCH 3/8] winsup/doc: Some preparatory XML fixes Jon TURNEY
@ 2015-06-15 17:04 ` Corinna Vinschen
2015-06-16 9:22 ` Jon TURNEY
0 siblings, 1 reply; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:04 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 644 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> Remove the inconsistent .exe suffix in strace and umount usage lines.
>
> Consistently refer to cross-references outside utils.xml as being in the Cygwin
> User's Guide. This helps to generate sensible looking references in generated
> manpages.
... but it generates a bit of clutter in the HTML user guide itself.
Any chance to add those *only* to the man pages?
Removing the date and trailing whitespaces is approved.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML
2015-06-15 12:37 ` [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML Jon TURNEY
@ 2015-06-15 17:05 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:05 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 496 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> fo.xsl doesn't seem to be used since c2f50c40 switched back from xsltproc to
> xmlto
>
> 2015-06-12 Jon Turney <...>
>
> * Makefile.in (cygwin-ug-net/cygwin-ug-net.pdf)
> (cygwin-api/cygwin-api.pdf): Use fo.xsl to customized DocBook
> XML->PDF conversion.
Please apply.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-15 12:37 ` [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry Jon TURNEY
@ 2015-06-15 17:11 ` Corinna Vinschen
2015-06-16 9:28 ` Jon TURNEY
0 siblings, 1 reply; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:11 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 668 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> Convert utils.xml from using a sect2 to using a refentry for each utility
> program.
>
> Unfortunately, using refentry seems to tickle a bug in dblatex when generating
> pdf, which appears to not escape \ properly in the latex for refentry, so use
> fop instead.
Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
the requirement to use fop andd thus java?
Is there really no other way to handle that, rather than reverting to
fop?
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets
2015-06-15 12:37 ` [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets Jon TURNEY
@ 2015-06-15 17:15 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:15 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 752 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> Change xidepend to create a variable containing all the XIncluded sources, which
> can be used as a dependency, rather than writing the dependency target itself.
>
> Future work: Makefile.dep should depend on xidepend, but xidepend should not be
> passed to itself.
>
> 2015-06-12 Jon Turney <...>
>
> * xidepend: Write a Makefile fragment defining variables
> containing all the XIncluded sources, rather than a dependency on
> those sources.
> * Makefile.in: Use that variable to express the dependency.
Please apply.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 8/8] winsup/doc: Fix an issue with parallel make
2015-06-15 12:37 ` [PATCH 8/8] winsup/doc: Fix an issue with parallel make Jon TURNEY
@ 2015-06-15 17:16 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 17:16 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 615 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> The cygwin-ug-net-nochunks.html.gz target does not ensure that the
> cygwin-ug-net/ directory exists, so it can fail if run on it's own, or if the
> cygwin-ug-net/cygwin-ug-net.html target has not yet created it in a parallel
> make.
>
> 2015-06-12 Jon Turney <...>
>
> * Makefile.in (cygwin-ug-net/cygwin-ug-net-nochunks.html.gz):
> Ensure cygwin-ug-net directory exists.
Please apply.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 7/8] winsup/doc: Make and install manpages for utils
2015-06-15 12:37 ` [PATCH 7/8] winsup/doc: Make and install manpages for utils Jon TURNEY
@ 2015-06-15 18:12 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-15 18:12 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 681 bytes --]
On Jun 15 13:36, Jon TURNEY wrote:
> Use 'xmlto man' to make manpages for utils
> (docbook2x-man could also be used, but since we already use xmlto...)
>
> This will generate multiple .1 files as an output, but we don't know what they
> will be called, so use a timestamp file for build avoidance when the
> dependencies haven't changed.
>
> 2015-06-12 Jon Turney <...>
>
> * Makefile.in (install-man, utils2man.stamp): Add rules to build
> and install manpages for utils.
Please apply.
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 3/8] winsup/doc: Some preparatory XML fixes
2015-06-15 17:04 ` Corinna Vinschen
@ 2015-06-16 9:22 ` Jon TURNEY
2015-06-16 9:35 ` Corinna Vinschen
0 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-16 9:22 UTC (permalink / raw)
To: cygwin-patches
On 15/06/2015 18:04, Corinna Vinschen wrote:
> On Jun 15 13:36, Jon TURNEY wrote:
>> Remove the inconsistent .exe suffix in strace and umount usage lines.
>>
>> Consistently refer to cross-references outside utils.xml as being in the Cygwin
>> User's Guide. This helps to generate sensible looking references in generated
>> manpages.
>
> ... but it generates a bit of clutter in the HTML user guide itself.
> Any chance to add those *only* to the man pages?
Ok, I'll look into how to do that.
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-15 17:11 ` Corinna Vinschen
@ 2015-06-16 9:28 ` Jon TURNEY
2015-06-16 9:45 ` Corinna Vinschen
0 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-16 9:28 UTC (permalink / raw)
To: cygwin-patches
On 15/06/2015 18:11, Corinna Vinschen wrote:
> On Jun 15 13:36, Jon TURNEY wrote:
>> Convert utils.xml from using a sect2 to using a refentry for each utility
>> program.
>>
>> Unfortunately, using refentry seems to tickle a bug in dblatex when generating
>> pdf, which appears to not escape \ properly in the latex for refentry, so use
>> fop instead.
>
> Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
> the requirement to use fop andd thus java?
>
> Is there really no other way to handle that, rather than reverting to
> fop?
Now I try again --with-dblatex, it works fine, so that part of the patch
can be removed.
I can only guess I must have had some other markup error causing me
problems, which has since been fixed.
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 3/8] winsup/doc: Some preparatory XML fixes
2015-06-16 9:22 ` Jon TURNEY
@ 2015-06-16 9:35 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-16 9:35 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 787 bytes --]
On Jun 16 10:22, Jon TURNEY wrote:
> On 15/06/2015 18:04, Corinna Vinschen wrote:
> >On Jun 15 13:36, Jon TURNEY wrote:
> >>Remove the inconsistent .exe suffix in strace and umount usage lines.
> >>
> >>Consistently refer to cross-references outside utils.xml as being in the Cygwin
> >>User's Guide. This helps to generate sensible looking references in generated
> >>manpages.
> >
> >... but it generates a bit of clutter in the HTML user guide itself.
> >Any chance to add those *only* to the man pages?
>
> Ok, I'll look into how to do that.
Preprocessing via m4 or something like that, would be ok...
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 9:28 ` Jon TURNEY
@ 2015-06-16 9:45 ` Corinna Vinschen
2015-06-16 11:09 ` Jon TURNEY
0 siblings, 1 reply; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-16 9:45 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 1028 bytes --]
On Jun 16 10:28, Jon TURNEY wrote:
> On 15/06/2015 18:11, Corinna Vinschen wrote:
> >On Jun 15 13:36, Jon TURNEY wrote:
> >>Convert utils.xml from using a sect2 to using a refentry for each utility
> >>program.
> >>
> >>Unfortunately, using refentry seems to tickle a bug in dblatex when generating
> >>pdf, which appears to not escape \ properly in the latex for refentry, so use
> >>fop instead.
> >
> >Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
> >the requirement to use fop andd thus java?
> >
> >Is there really no other way to handle that, rather than reverting to
> >fop?
>
> Now I try again --with-dblatex, it works fine, so that part of the patch can
> be removed.
>
> I can only guess I must have had some other markup error causing me
> problems, which has since been fixed.
I'm relieved :}
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 9:45 ` Corinna Vinschen
@ 2015-06-16 11:09 ` Jon TURNEY
2015-06-16 12:49 ` Corinna Vinschen
0 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-16 11:09 UTC (permalink / raw)
To: cygwin-patches
On 16/06/2015 10:45, Corinna Vinschen wrote:
> On Jun 16 10:28, Jon TURNEY wrote:
>> On 15/06/2015 18:11, Corinna Vinschen wrote:
>>> On Jun 15 13:36, Jon TURNEY wrote:
>>>> Convert utils.xml from using a sect2 to using a refentry for each utility
>>>> program.
>>>>
>>>> Unfortunately, using refentry seems to tickle a bug in dblatex when generating
>>>> pdf, which appears to not escape \ properly in the latex for refentry, so use
>>>> fop instead.
>>>
>>> Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
>>> the requirement to use fop andd thus java?
>>>
>>> Is there really no other way to handle that, rather than reverting to
>>> fop?
>>
>> Now I try again --with-dblatex, it works fine, so that part of the patch can
>> be removed.
>>
>> I can only guess I must have had some other markup error causing me
>> problems, which has since been fixed.
>
> I'm relieved :}
Approved with that change?
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 11:09 ` Jon TURNEY
@ 2015-06-16 12:49 ` Corinna Vinschen
2015-06-16 17:33 ` Jon TURNEY
0 siblings, 1 reply; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-16 12:49 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 1202 bytes --]
On Jun 16 12:09, Jon TURNEY wrote:
> On 16/06/2015 10:45, Corinna Vinschen wrote:
> >On Jun 16 10:28, Jon TURNEY wrote:
> >>On 15/06/2015 18:11, Corinna Vinschen wrote:
> >>>On Jun 15 13:36, Jon TURNEY wrote:
> >>>>Convert utils.xml from using a sect2 to using a refentry for each utility
> >>>>program.
> >>>>
> >>>>Unfortunately, using refentry seems to tickle a bug in dblatex when generating
> >>>>pdf, which appears to not escape \ properly in the latex for refentry, so use
> >>>>fop instead.
> >>>
> >>>Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
> >>>the requirement to use fop andd thus java?
> >>>
> >>>Is there really no other way to handle that, rather than reverting to
> >>>fop?
> >>
> >>Now I try again --with-dblatex, it works fine, so that part of the patch can
> >>be removed.
> >>
> >>I can only guess I must have had some other markup error causing me
> >>problems, which has since been fixed.
> >
> >I'm relieved :}
>
> Approved with that change?
Yep, thanks.
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 12:49 ` Corinna Vinschen
@ 2015-06-16 17:33 ` Jon TURNEY
2015-06-16 17:49 ` Corinna Vinschen
0 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-16 17:33 UTC (permalink / raw)
To: cygwin-patches
On 16/06/2015 13:49, Corinna Vinschen wrote:
> On Jun 16 12:09, Jon TURNEY wrote:
>> On 16/06/2015 10:45, Corinna Vinschen wrote:
>>> On Jun 16 10:28, Jon TURNEY wrote:
>>>> On 15/06/2015 18:11, Corinna Vinschen wrote:
>>>>> On Jun 15 13:36, Jon TURNEY wrote:
>>>>>> Convert utils.xml from using a sect2 to using a refentry for each utility
>>>>>> program.
>>>>>>
>>>>>> Unfortunately, using refentry seems to tickle a bug in dblatex when generating
>>>>>> pdf, which appears to not escape \ properly in the latex for refentry, so use
>>>>>> fop instead.
>>>>>
>>>>> Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
>>>>> the requirement to use fop andd thus java?
>>>>>
>>>>> Is there really no other way to handle that, rather than reverting to
>>>>> fop?
>>>>
>>>> Now I try again --with-dblatex, it works fine, so that part of the patch can
>>>> be removed.
>>>>
>>>> I can only guess I must have had some other markup error causing me
>>>> problems, which has since been fixed.
>>>
>>> I'm relieved :}
>>
>> Approved with that change?
>
> Yep, thanks.
Done.
Note that the next time you build documentation for the website, you
might need to take some special steps to add new .html files.
and next time you build a package you might need to take some special
steps to exclude /usr/share/man/
Please let me know if there are any problems with these changes.
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 17:33 ` Jon TURNEY
@ 2015-06-16 17:49 ` Corinna Vinschen
2015-06-16 18:50 ` Jon TURNEY
0 siblings, 1 reply; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-16 17:49 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 1842 bytes --]
On Jun 16 18:33, Jon TURNEY wrote:
> On 16/06/2015 13:49, Corinna Vinschen wrote:
> >On Jun 16 12:09, Jon TURNEY wrote:
> >>On 16/06/2015 10:45, Corinna Vinschen wrote:
> >>>On Jun 16 10:28, Jon TURNEY wrote:
> >>>>On 15/06/2015 18:11, Corinna Vinschen wrote:
> >>>>>On Jun 15 13:36, Jon TURNEY wrote:
> >>>>>>Convert utils.xml from using a sect2 to using a refentry for each utility
> >>>>>>program.
> >>>>>>
> >>>>>>Unfortunately, using refentry seems to tickle a bug in dblatex when generating
> >>>>>>pdf, which appears to not escape \ properly in the latex for refentry, so use
> >>>>>>fop instead.
> >>>>>
> >>>>>Uhm... wasn't Yaakov's patch from 2014-11-28 explicitely meant to drop
> >>>>>the requirement to use fop andd thus java?
> >>>>>
> >>>>>Is there really no other way to handle that, rather than reverting to
> >>>>>fop?
> >>>>
> >>>>Now I try again --with-dblatex, it works fine, so that part of the patch can
> >>>>be removed.
> >>>>
> >>>>I can only guess I must have had some other markup error causing me
> >>>>problems, which has since been fixed.
> >>>
> >>>I'm relieved :}
> >>
> >>Approved with that change?
> >
> >Yep, thanks.
>
> Done.
>
> Note that the next time you build documentation for the website, you might
> need to take some special steps to add new .html files.
-v, please?
> and next time you build a package you might need to take some special steps
> to exclude /usr/share/man/
What special steps? I assume a `make install' will install the
additional man pages now. Wouldn't it make sense to install them as
part of the Cygwin package then, rather than as part of cygwin-doc?
Thanks,
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 17:49 ` Corinna Vinschen
@ 2015-06-16 18:50 ` Jon TURNEY
2015-06-16 19:17 ` Corinna Vinschen
0 siblings, 1 reply; 27+ messages in thread
From: Jon TURNEY @ 2015-06-16 18:50 UTC (permalink / raw)
To: cygwin-patches
On 16/06/2015 18:49, Corinna Vinschen wrote:
>> Note that the next time you build documentation for the website, you might
>> need to take some special steps to add new .html files.
>
> -v, please?
Sorry, I wasn't being intentionally vague, but I don't know precisely
how you push documentation updates.
I guess you will need to do a 'cvs add *.html'
>> and next time you build a package you might need to take some special steps
>> to exclude /usr/share/man/
>
> What special steps? I assume a `make install' will install the
> additional man pages now. Wouldn't it make sense to install them as
> part of the Cygwin package then, rather than as part of cygwin-doc?
Ultimately, I think it would be a good idea if cygwin-doc was generated
by the same process which builds the cygwin(|-devel|-debuginfo) packages.
But we are some way from there yet.
My thought was that the simplest way to do the transition is to exclude
all the files currently owned by cygwin-doc until then, but maybe you
have a different idea.
^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry
2015-06-16 18:50 ` Jon TURNEY
@ 2015-06-16 19:17 ` Corinna Vinschen
0 siblings, 0 replies; 27+ messages in thread
From: Corinna Vinschen @ 2015-06-16 19:17 UTC (permalink / raw)
To: cygwin-patches
[-- Attachment #1: Type: text/plain, Size: 1989 bytes --]
On Jun 16 19:50, Jon TURNEY wrote:
> On 16/06/2015 18:49, Corinna Vinschen wrote:
> >>Note that the next time you build documentation for the website, you might
> >>need to take some special steps to add new .html files.
> >
> >-v, please?
>
> Sorry, I wasn't being intentionally vague, but I don't know precisely how
> you push documentation updates.
>
> I guess you will need to do a 'cvs add *.html'
Oh, I see. I didn't realize from the start that utils.xml is also split
into multiple html files now.
> >>and next time you build a package you might need to take some special steps
> >>to exclude /usr/share/man/
> >
> >What special steps? I assume a `make install' will install the
> >additional man pages now. Wouldn't it make sense to install them as
> >part of the Cygwin package then, rather than as part of cygwin-doc?
>
> Ultimately, I think it would be a good idea if cygwin-doc was generated by
> the same process which builds the cygwin(|-devel|-debuginfo) packages.
Yes, that sounds right to me...
> But we are some way from there yet.
...and I'm open to patches to make it reality :)
> My thought was that the simplest way to do the transition is to exclude all
> the files currently owned by cygwin-doc until then, but maybe you have a
> different idea.
Hmm, no. The cygwin package comes with the PDF and HTML files under
/usr/share/doc/cygwin-${PV}, the cygwin-devel package with the files
/usr/share/man/man3/regex.3.gz
/usr/share/man/man7/regex.7.gz
(and an undesired usr/share/man/man3/2.0.3.gz, which I only now see.
Oh well)
In theory these man pages as well as the other doc files would be
ideally bundled with the cygwin-doc package at one point.
For the time being, I look into excluding the utils man pages in the
cygwin package.
Corinna
--
Corinna Vinschen Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 27+ messages in thread
end of thread, other threads:[~2015-06-16 19:17 UTC | newest]
Thread overview: 27+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-06-15 12:36 [PATCH 0/8] Generate utilities manpages Jon TURNEY
2015-06-15 12:37 ` [PATCH 2/8] winsup/doc: Fix xidepend to handle relative pathnames Jon TURNEY
2015-06-15 17:02 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 7/8] winsup/doc: Make and install manpages for utils Jon TURNEY
2015-06-15 18:12 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 5/8] winsup/doc: Convert utils.xml to using refentry Jon TURNEY
2015-06-15 17:11 ` Corinna Vinschen
2015-06-16 9:28 ` Jon TURNEY
2015-06-16 9:45 ` Corinna Vinschen
2015-06-16 11:09 ` Jon TURNEY
2015-06-16 12:49 ` Corinna Vinschen
2015-06-16 17:33 ` Jon TURNEY
2015-06-16 17:49 ` Corinna Vinschen
2015-06-16 18:50 ` Jon TURNEY
2015-06-16 19:17 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 3/8] winsup/doc: Some preparatory XML fixes Jon TURNEY
2015-06-15 17:04 ` Corinna Vinschen
2015-06-16 9:22 ` Jon TURNEY
2015-06-16 9:35 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 6/8] winsup/doc: Make it easier to extend xidepend to more targets Jon TURNEY
2015-06-15 17:15 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 8/8] winsup/doc: Fix an issue with parallel make Jon TURNEY
2015-06-15 17:16 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 4/8] winsup/doc: Use fo.xsl to customize PDF generation from DocBook XML Jon TURNEY
2015-06-15 17:05 ` Corinna Vinschen
2015-06-15 12:37 ` [PATCH 1/8] winsup/doc: Remove tarball target from .PHONY Jon TURNEY
2015-06-15 16:52 ` 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).