From 4e46ff3e8198adc00bbf4b4455c760ff0c599f44 Mon Sep 17 00:00:00 2001 From: Jon Turney Date: Sat, 7 Jan 2017 20:21:59 +0000 Subject: [PATCH] Make anchors stable in generated Cygwin HTML documentation Give more elements ids, so random ids aren't assigned to them, so anchors are stable between builds. Signed-off-by: Jon Turney --- winsup/doc/logon-funcs.xml | 8 ++-- winsup/doc/misc-funcs.xml | 6 +-- winsup/doc/path.xml | 22 +++++----- winsup/doc/utils.xml | 90 +++++++++++++++++++------------------- 4 files changed, 63 insertions(+), 63 deletions(-) diff --git a/winsup/doc/logon-funcs.xml b/winsup/doc/logon-funcs.xml index 084b0c798..31da4be5e 100644 --- a/winsup/doc/logon-funcs.xml +++ b/winsup/doc/logon-funcs.xml @@ -29,7 +29,7 @@ - + Description Given a pointer to a passwd entry of a user and a cleartext password, returns a HANDLE to an impersonation token for this user which can be used @@ -38,7 +38,7 @@ to impersonate that user. This function can only be called from a process which has the required NT user rights to perform a logon. - + See also See also the chapter Switching the user context @@ -71,7 +71,7 @@ in the Cygwin User's guide. - + Description Use this function to enable the token given as parameter as impersonation token for the next call to setuid or @@ -81,7 +81,7 @@ impersonation token for the next call to setuid or password authentication. - + See also See also the chapter Switching the user context diff --git a/winsup/doc/misc-funcs.xml b/winsup/doc/misc-funcs.xml index 16b3d61eb..7463942e6 100644 --- a/winsup/doc/misc-funcs.xml +++ b/winsup/doc/misc-funcs.xml @@ -32,7 +32,7 @@ - + Description This function can be used to turn a Win32 "handle" into a posix-style file handle. fd may be -1 to @@ -70,7 +70,7 @@ much. - + Description This function gives you access to various internal data and functions. It takes two arguments. The first argument is a type from the 'cygwin_getinfo_types' @@ -103,7 +103,7 @@ enum. The second is an optional pointer. - + Description Outputs a stackdump to stderr from the called location. diff --git a/winsup/doc/path.xml b/winsup/doc/path.xml index 81d4c3f35..f56614bb6 100644 --- a/winsup/doc/path.xml +++ b/winsup/doc/path.xml @@ -31,7 +31,7 @@ - + Description Use this function to convert POSIX paths in from to Win32 paths in to @@ -75,9 +75,9 @@ error and errno is set to one of the below values. - + Example - + Example use of cygwin_conv_path - + Description This is the same as cygwin_conv_path, but the input is treated as a path list in $PATH or %PATH% notation. @@ -144,7 +144,7 @@ convert it to the equivalent POSIX $PATH-style string (i.e. /foo:/bar). to in bytes. - + See also See also cygwin_conv_path @@ -174,7 +174,7 @@ convert it to the equivalent POSIX $PATH-style string (i.e. /foo:/bar). - + Description This is equivalent to the cygwin_conv_path, except that cygwin_create_path does not take a buffer pointer @@ -192,7 +192,7 @@ errno can be set to the below value. free(3) to deallocate it. - + See also See also cygwin_conv_path @@ -221,7 +221,7 @@ errno can be set to the below value. - + Description This function tells you if the supplied path is a POSIX-style path (i.e. posix names, @@ -259,16 +259,16 @@ parameter. - + Description Split a path into the directory and the file portions. Both dir and file are expected to point to buffers of sufficient size. - + Example - + Example use of cygwin_split_path char dir[200], file[100]; diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml index 4af6583da..948db5832 100644 --- a/winsup/doc/utils.xml +++ b/winsup/doc/utils.xml @@ -39,7 +39,7 @@ cygcheck -h - + Options At least one command option or a PROGRAM is required, as shown above. @@ -71,7 +71,7 @@ Note: -c, -f, and -l only report on packages that are currently installed. To - + Description The cygcheck program is a diagnostic utility for dealing with Cygwin programs. If you are familiar with @@ -245,7 +245,7 @@ cygpath [-F ID] - + Options Output type options: @@ -293,7 +293,7 @@ Other options: - + Description The cygpath program is a utility that converts Windows native filenames to Cygwin POSIX-style pathnames and vice versa. @@ -429,7 +429,7 @@ dumper [OPTION] FILENAME WIN32PID - + Options -d, --verbose be verbose while dumping @@ -439,7 +439,7 @@ dumper [OPTION] FILENAME WIN32PID - + Description The dumper utility can be used to create a core dump of running Windows process. This core dump can be later loaded to @@ -490,7 +490,7 @@ getconf -a [pathname] - + Options -v specification Indicate specific version for which configuration @@ -504,7 +504,7 @@ Other options: - + Description The getconf utility prints the value of the configuration variable specified by variable_name. If @@ -553,7 +553,7 @@ getfacl [-adceEn] FILE [FILE2...] - + Options -a, --access display the file access control list only @@ -570,7 +570,7 @@ line separates the ACLs for each file. - + Description For each argument that is a regular file, special file or directory, getfacl displays the owner, the group, and the ACL. @@ -622,7 +622,7 @@ kill -l [signal] - + Options -f, --force force, using win32 interface if necessary @@ -633,7 +633,7 @@ kill -l [signal] - + Description The kill program allows you to send arbitrary signals to other Cygwin programs. The usual purpose is to end a running @@ -739,7 +739,7 @@ ldd [OPTION]... FILE... - + Options -h, --help print this help and exit @@ -753,12 +753,12 @@ ldd [OPTION]... FILE... - + Description ldd prints the shared libraries (DLLs) loaded when running an executable or DLL. - + Security ldd invokes the Windows loader on the file specified, @@ -791,7 +791,7 @@ locale [-iusfnU] - + Options System information: @@ -822,7 +822,7 @@ Other options: - + Description locale without parameters prints information about the current locale environment settings. @@ -969,7 +969,7 @@ minidumper [OPTION] FILENAME WIN32PID - + Options -t, --type minidump type flags @@ -981,7 +981,7 @@ minidumper [OPTION] FILENAME WIN32PID - + Description The minidumper utility can be used to create a @@ -1022,7 +1022,7 @@ mkgroup [OPTION]... - + Options Options: @@ -1053,7 +1053,7 @@ groups on domain controllers and domain member machines. - + Description 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. @@ -1126,7 +1126,7 @@ mkpasswd [OPTIONS]... - + Options Options: @@ -1160,7 +1160,7 @@ on domain controllers and domain member machines. - + Description 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. @@ -1240,7 +1240,7 @@ mount <posixpath> - + Options -a, --all mount all filesystems mentioned in fstab @@ -1256,7 +1256,7 @@ mount <posixpath> - + Description The mount program is used to map your drives and shares onto Cygwin's simulated POSIX directory tree, much like as is done @@ -1504,7 +1504,7 @@ passwd [OPTION] [USER] - + Options User operations: @@ -1550,7 +1550,7 @@ specifying an empty password. - + Description passwd changes passwords for user accounts. A normal user may only change the password for their own account, but @@ -1665,7 +1665,7 @@ pldd [OPTION...] PID - + Options -?, --help Give this help list @@ -1674,7 +1674,7 @@ pldd [OPTION...] PID - + Description pldd prints the shared libraries (DLLs) loaded by the process with the given PID. @@ -1699,7 +1699,7 @@ ps [-aefls] [-u UID] - + Options -a, --all show processes of all users @@ -1716,7 +1716,7 @@ With no options, ps outputs the long format by default - + Description The ps program gives the status of all the Cygwin processes running on the system (ps = "process status"). Due to the @@ -1772,7 +1772,7 @@ regtool [OPTION] (add|check|get|list|remove|unset|load|unload|save) KEY - + Options Actions: @@ -1844,7 +1844,7 @@ Example: regtool get '\user\software\Microsoft\Clock\iFormat' - + Description The regtool program allows shell scripts to access and modify the Windows registry. Note that modifying the Windows registry @@ -1963,7 +1963,7 @@ setfacl [-n] {[-bk]|[-x acl_entries] [-m acl_entries]} FILE... - + Options -b, --remove-all remove all extended ACL entries\n" @@ -1982,7 +1982,7 @@ At least one of (-b, -x, -f, -k, -m, -s) must be specified\n" - + Description For each file given as parameter, setfacl will either replace its complete ACL (-s, @@ -2111,7 +2111,7 @@ setmetamode [metabit|escprefix] - + Options Without argument, it shows the current meta key mode. @@ -2126,7 +2126,7 @@ Other options: - + Description setmetamode can be used to determine and set the key code sent by the meta (aka Alt) key. @@ -2151,7 +2151,7 @@ ssp [options] low_pc high_pc command... - + Options -c, --console-trace trace every EIP value to the console. *Lots* slower. @@ -2173,7 +2173,7 @@ Example: ssp 0x401000 0x403000 hello.exe - + Description SSP - The Single Step Profiler @@ -2326,7 +2326,7 @@ strace [OPTIONS] -p <pid> - + Options -b, --buffer-size=SIZE set size of output file buffer @@ -2381,7 +2381,7 @@ strace [OPTIONS] -p <pid> - + Description The strace program executes a program, and optionally the children of the program, reporting any Cygwin DLL output @@ -2420,7 +2420,7 @@ tzset [OPTION] - + Options Options: @@ -2429,7 +2429,7 @@ Options: - + Description Use tzset to set your TZ variable. In POSIX-compatible shells like bash, dash, mksh, or zsh: @@ -2466,7 +2466,7 @@ umount [OPTION] [<posixpath>] - + Options -h, --help output usage information and exit @@ -2475,7 +2475,7 @@ umount [OPTION] [<posixpath>] - + Description The umount program removes mounts from the mount table in the current session. If you specify a POSIX path that