[PATCH 0/3] Small documentation fixes

2016-07-05 Thread Jon Turney
Jon Turney (3):
  Use  tag at same level as , not inside it
  Use  tag, not  tag
  Improve description of Cygwin ldd utility

 winsup/doc/utils.xml | 43 ---
 1 file changed, 32 insertions(+), 11 deletions(-)

-- 
2.8.3



[PATCH 1/3] Use tag at same level as , not inside it

2016-07-05 Thread Jon Turney
In Cygwin utils documentation, use the  tag at same level as
, not inside it.

This improves the generated manpages.

Signed-off-by: Jon Turney 
---
 winsup/doc/utils.xml | 25 ++---
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index 08a24f7..4853d92 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -102,7 +102,10 @@ Note: -c, -f, and -l only report on packages that are 
currently installed. To
  The -f option helps you to track down which
   package a file came from, and -l lists all files in a
   package. For example, to find out about
-  /usr/bin/less and its package: /usr/bin/less and its package:
+
+
+Example cygcheck
   usage
   
@@ -116,7 +119,7 @@ $ cygcheck -l less
 /usr/man/man1/less.1
 /usr/man/man1/lesskey.1
 
-   
+  
 
 The -h option prints additional helpful messages
   in the report, at the beginning of each section. It also adds table
@@ -150,7 +153,9 @@ $ cygcheck -l less
 
 For example, perhaps you are getting an error because you are missing
   a certain DLL and you want to know which package includes that file:
-  Searching all packages for a
+
+
+Searching all packages for a
   file
   
 $ cygcheck -p 'cygintl-2\.dll'
@@ -170,7 +175,7 @@ Found 2 matches for '/ls\.exe'.
 coreutils-5.2.1-5 GNU core utilities (includes fileutils, sh-utils and 
textutils)
 coreutils-5.3.0-6 GNU core utilities (includes fileutils, sh-utils and 
textutils)
 
-   
+  
 
 Note that this option takes a regular expression, not a glob or
   wildcard. This means that you need to use .* if you
@@ -1168,19 +1173,25 @@ on domain controllers and domain member machines.
   multiple domains) where the UIDs might match otherwise. The
   -p option causes mkpasswd to use
   the specified prefix instead of the account home dir or /home/
-  . For example, this command: . For example, this command:
+
+
+Using an alternate home root
   
 $ mkpasswd -l -p "$(cygpath -H)" > 
/etc/passwd
 
-   would put local users' home directories in the Windows
+
+
+
+  would put local users' home directories in the Windows
   'Profiles' directory. The -u option creates just an
   entry for the specified user. The -U option allows you
   to enumerate the standard UNIX users on a Samba machine. It's used
   together with -l samba-server or -L
   samba-server. The normal UNIX users are usually not enumerated,
   but they can show up as file owners in ls -l output.
-  
+
 
   
 
-- 
2.8.3



[PATCH 3/3] Improve description of Cygwin ldd utility

2016-07-05 Thread Jon Turney
Improve the description of Cygwin ldd utility to give a bit more detail
about how it does what it does

Also add a security warning (modelled after the one in the Linux manpage)
that it may end up executing the file it is applied to.

Signed-off-by: Jon Turney 
---
 winsup/doc/utils.xml | 16 +---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index 12949c5..906c377 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -755,10 +755,20 @@ ldd [OPTION]... FILE...
 
 
   Description
-ldd prints the shared libraries (DLLs) an
-  executable or DLL is linked against. No modifying option is implemented
-  yet.
+  ldd prints the shared libraries (DLLs) loaded
+  when running an executable or DLL.
+
+
+  Security
+  
+   ldd invokes the Windows loader on the file specified,
+   then uses the Windows debugging interface to report DLLs loaded, and
+   (for executables) to attempt to stop execution before the entrypoint.
+   Thus, you should never use ldd on an untrusted file.
+  
+
 
+
   
 
   
-- 
2.8.3



[PATCH 2/3] Use tag, not tag

2016-07-05 Thread Jon Turney
Fix an instance of the invalid  tag in Cygwin utils documentation,
by using the valid  tag instead.

Signed-off-by: Jon Turney 
---
 winsup/doc/utils.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index 4853d92..12949c5 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -335,7 +335,7 @@ Other options:
 However, the cygdrive prefix can be changed by the user, so symbolic links
 created using the cygdrive prefix are not foolproof.  With
 -U cygpath will generate such paths prepended by the
-virtual /proc/cygdrive symbolic link, which will
+virtual /proc/cygdrive symbolic link, which will
 never change, so the created path is safe against changing the cygdrive
 prefix.
 
-- 
2.8.3



Re: [PATCH 0/3] Small documentation fixes

2016-07-05 Thread Corinna Vinschen
On Jul  5 11:07, Jon Turney wrote:
> Jon Turney (3):
>   Use  tag at same level as , not inside it
>   Use  tag, not  tag
>   Improve description of Cygwin ldd utility
> 
>  winsup/doc/utils.xml | 43 ---
>  1 file changed, 32 insertions(+), 11 deletions(-)

Looks good, please apply.


Thanks,
Corinna

-- 
Corinna Vinschen  Please, send mails regarding Cygwin to
Cygwin Maintainer cygwin AT cygwin DOT com
Red Hat


signature.asc
Description: PGP signature