Signed-off-by: Jason St. John <jstjohn@purdue.edu> --- doc/PKGBUILD.5.txt | 2 +- doc/makepkg-template.1.txt | 2 +- doc/makepkg.8.txt | 10 +++++----- doc/makepkg.conf.5.txt | 4 ++-- doc/pacman-key.8.txt | 3 ++- doc/pacman.conf.5.txt | 11 ++++++----- doc/pactree.8.txt | 12 ++++++------ doc/repo-add.8.txt | 7 ++++--- doc/submitting-patches.txt | 14 +++++++------- doc/translation-help.txt | 27 +++++++++++++-------------- doc/vercmp.8.txt | 4 ++-- 11 files changed, 49 insertions(+), 47 deletions(-) diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index 34c6d0b..e99e826 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -370,7 +370,7 @@ given in the PKGBUILD. Nevertheless, the following ones can be overridden within each split package's packaging function: `pkgver`, `pkgrel`, `epoch`, `pkgdesc`, `arch`, `url`, `license`, `groups`, `depends`, `optdepends`, `provides`, `conflicts`, `replaces`, `backup`, -`options`, `install` and `changelog`. +`options`, `install`, and `changelog`. An optional global directive is available when building a split package: diff --git a/doc/makepkg-template.1.txt b/doc/makepkg-template.1.txt index 49eb8fd..a0a6303 100644 --- a/doc/makepkg-template.1.txt +++ b/doc/makepkg-template.1.txt @@ -35,7 +35,7 @@ and # template end; Currently used keys are: name (mandatory) and version. Template names are limited to -alphanumerics, "@", "+", ".", "-" and "_". Versions are limited to numbers and ".". +alphanumerics, "@", "+", ".", "-", and "_". Versions are limited to numbers and ".". For initial creation there is a one line short cut which does not need an end marker: diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 1a42633..d6d58b0 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -45,7 +45,7 @@ Options Clean up leftover work files and directories after a successful build. *\--config* <file>:: - Use an alternate config file instead of the +{sysconfdir}/makepkg.conf+ + Use an alternate configuration file instead of the +{sysconfdir}/makepkg.conf+ default. *-d, \--nodeps*:: @@ -126,7 +126,7 @@ Options *-R, \--repackage*:: Repackage contents of the package without rebuilding the package. This - is useful if you forgot (e.g.) a dependency or install file in your + is useful if you forgot, for example, a dependency or install file in your PKGBUILD and the build itself will not change. *-s, \--syncdeps*:: @@ -191,11 +191,11 @@ Options *\--needed*:: (Passed to pacman) Tell pacman not to reinstall a target if it is already - up to date. (used with -i / --install). + up-to-date. (used with '-i' / '\--install'). *\--asdeps*:: (Passed to pacman) Install packages as non-explicitly installed (used - with -i / --install). + with '-i' / '\--install'). *\--noprogressbar*:: (Passed to pacman) Prevent pacman from displaying a progress bar; @@ -214,7 +214,7 @@ Environment Variables --------------------- **PACMAN**:: The command that will be used to check for missing dependencies and to - install and remove packages. Pacman's -Qq, -Rns, -S, -T, and -U + install and remove packages. Pacman's '-Qq', '-Rns', '-S', '-T', and '-U' operations must be supported by this command. If the variable is not set or empty, makepkg will fall back to `pacman'. diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index 16cd5e9..158dd63 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -53,11 +53,11 @@ Options installation. **CHOST=**"chost":: - A string such as ``i686-pc-linux-gnu''; do not touch unless you know what + A string such as ``i686-pc-linux-gnu''; do not touch this unless you know what you are doing. This can be commented out by most users if desired. **CPPFLAGS=**"cppflags":: - Flags used for the C preprocessor; see CFLAGS for more info. + Flags used for the C preprocessor; see CFLAGS for more information. **CFLAGS=**"cflags":: Flags used for the C compiler. This is a key part to the use of makepkg. diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index a04cbdf..3c947f7 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -102,10 +102,11 @@ Operations *-v, \--verify*:: Verify the file(s) specified by the signature(s). + Options ------- *\--config* <file>:: - Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ + Use an alternate configuration file instead of the +{sysconfdir}/pacman.conf+ default. *\--gpgdir* <dir>:: diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index aa80e57..383e072 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -45,13 +45,14 @@ NOTE: Each directive must be in CamelCase. If the case isn't respected, the directive won't be recognized. For example. noupgrade or NOUPGRADE will not work. + Options ------- *RootDir =* path/to/root:: Set the default root directory for pacman to install to. This option is used if you want to install a package on a temporary mounted partition which is "owned" by another system, or for a chroot install. - *NOTE*: If database path or logfile are not specified on either the + *NOTE*: If database path or log file are not specified on either the command line or in linkman:pacman.conf[5], their default location will be inside this root path. @@ -99,15 +100,15 @@ Options allowed. *Include =* path:: - Include another config file. This file can include repositories or + Include another configuration file. This file can include repositories or general configuration options. Wildcards in the specified paths will get expanded based on linkman:glob[7] rules. *Architecture =* auto | i686 | x86_64 | ...:: If set, pacman will only allow installation of packages of the given architecture (e.g. 'i686', 'x86_64', etc). The special value 'auto' will - use the system architecture, provided by in ``uname -m''. If unset, no - architecture checks are made. *NOTE*: packages with the special + use the system architecture, provided via ``uname -m''. If unset, no + architecture checks are made. *NOTE*: Packages with the special architecture 'any' can always be installed, as they are meant to be architecture independent. @@ -119,7 +120,7 @@ Options properly. + This option is useful for users who experience problems with built-in - http/ftp support, or need the more advanced proxy support that comes with + HTTP/FTP support, or need the more advanced proxy support that comes with utilities like wget. *NoUpgrade =* file ...:: diff --git a/doc/pactree.8.txt b/doc/pactree.8.txt index c99d4f1..b177788 100644 --- a/doc/pactree.8.txt +++ b/doc/pactree.8.txt @@ -18,14 +18,14 @@ Description ----------- Pactree produces a dependency tree for a package. -By default a tree like output is generated, but with the -g option a graphviz +By default, a tree-like output is generated, but with the '\--graph' option, a Graphviz description is generated. Options ------- *-a, \--ascii*:: - Use ascii characters for tree formatting. By default, pactree will use unicode + Use ASCII characters for tree formatting. By default, pactree will use Unicode line drawing characters if it is able to detect that the locale supports them. *-b, \--dbpath*:: @@ -40,11 +40,11 @@ Options required. *-g, \--graph*:: - Generate graphviz description. If this option is given, the -c and -l - options are ignored. + Generate a Graphviz description. If this option is given, the '\--color' and + '\--linear' options are ignored. *-h, \--help*:: - Output syntax and command line options. + Output syntax and command-line options. *-l, \--linear*:: Prints package names at the start of each line, one per line. @@ -56,7 +56,7 @@ Options Read package data from sync databases instead of local database. *-u, \--unique*:: - List dependent packages once. Implies --linear. + List dependent packages once. Implies '\--linear'. *\--config <file>*:: Specify an alternate pacman configuration file. diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index b96668c..f096d71 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -42,7 +42,7 @@ to exist, but all parent directories must exist. Common Options -------------- *-q, \--quiet*:: - Force this program to keep quiet and run silent except for warning and + Force this program to keep quiet and run silently except for warning and error messages. *-s, \--sign*:: @@ -62,7 +62,8 @@ Common Options proceed. *\--nocolor*:: - Remove color from repo-add and repo-remove output. + Remove color from 'repo-add' and 'repo-remove' output. + repo-add Options ---------------- @@ -71,7 +72,7 @@ repo-add Options new one, if the old package file is found next to the new one. *-f, \--files*:: - Tells repo-add also to create and include a list of the files in the + Tells 'repo-add' also to create and include a list of the files in the specified packages. This is useful for creating databases listing all files in a given sync repository for tools that may use this information. diff --git a/doc/submitting-patches.txt b/doc/submitting-patches.txt index 7c61dd1..77ec771 100644 --- a/doc/submitting-patches.txt +++ b/doc/submitting-patches.txt @@ -60,7 +60,7 @@ Submitting your patch * Send the patch to the pacman-dev mailing list The mailing list is the primary queue for review and acceptance. Here you -will get feedback, and let me know the details of your patch. +will get feedback, and let the reviewers know the details of your patch. * No MIME, no links, no compression, no attachments. Just plain text. @@ -69,9 +69,9 @@ reasons for this. First, it makes them easier to read with any mail reader, it allows easier review "at a glance", and most importantly, it allows people to comment on exact lines of the patch in reply emails. -`git send-email` allows you to send git formatted patches in plain text easily +`git send-email` allows you to send Git-formatted patches in plain text easily and is the preferred method for submission to the mailing list. Mail clients, -including gmail's web interface, have a tendency to break patches by wrapping +including Gmail's web interface, have a tendency to break patches by wrapping lines and/or adjusting whitespace and should be avoided. -- @@ -92,11 +92,11 @@ looked at it yet. * Respond to feedback When you do get feedback, it usually merits a response, whether this be a -resubmit of the patch with corrections or a follow-up email asking for -clarifications. When neither of these occurs, don't expect your patch to see +resubmission of the patch with corrections or a follow-up email asking for +clarifications. When neither of these occurs, don't expect your patch to get further review. The all-volunteer staff don't have time to fix up patches that -aren't their own. When resubmitting patches update the subject line to reflect -the version number ('[PATCHv2]') and send it as a reply to the original thread. +aren't their own. When resubmitting patches, update the subject line to reflect +the version number ('[PATCHv2]'), and send it as a reply to the original thread. -- diff --git a/doc/translation-help.txt b/doc/translation-help.txt index 7b8134e..1fdb6e0 100644 --- a/doc/translation-help.txt +++ b/doc/translation-help.txt @@ -2,7 +2,7 @@ Pacman - Translating ==================== This document is here to guide you in helping translate pacman messages, -libalpm messages, and the manpages for the entire pacman package. +libalpm messages, and the manual pages for the entire pacman package. We are currently using http://www.transifex.net/[Transifex] as the translation platform for pacman and libalpm. You will need to sign up for an account there @@ -23,13 +23,13 @@ Translating Messages Overview ~~~~~~~~ -There are two separate message catalogs in pacman- one for the backend -(libalpm) and one for the frontend (pacman and scripts). These correspond to +There are two separate message catalogs in pacman: one for the back-end +(libalpm) and one for the front-end (pacman and scripts). These correspond to the `lib/libalpm/po` and `po` directories in the pacman source, respectively. Translation message files are a specially formatted text file containing the original message and the corresponding translation. These po files can then -either be hand edited, or modified with a tool such as poedit, gtranslator or +either be hand-edited, or modified with a tool such as poedit, gtranslator or kbabel. Using a translation tool tends to make the job easier. Please read up on Transifex usage using the @@ -61,8 +61,8 @@ mailing list asking for translations. This email will have a prefix of *[translation]* for anyone looking to set up an email filter. At this time, the latest `.po` language files will be made available at the -Transifex project page. Each language will have two files available (backend -and frontend). Translators interested in helping are encouraged to use the +Transifex project page. Each language will have two files available (back-end +and front-end). Translators interested in helping are encouraged to use the features of Transifex to let others know they are currently translating their language. @@ -99,7 +99,7 @@ Next, update your specific language's translation file: At this point, you can do the translation. To submit your changes, either email the new `.po` file to the mailing-list with *[translation]* in the subject, or -submit a GIT-formatted patch (please do not include any `.pot` file changes). +submit a Git-formatted patch (please do not include any `.pot` file changes). As a shortcut, all translation files (including `.pot` files) can be updated with the following command: @@ -130,7 +130,7 @@ Notes[[Notes]] ~~~~~~~~~~~~~~ msgid and msgstr 'variables' can be on as many lines as necessary. Line breaks -are ignored- if you need a literal line break, use an `\n` in your string. The +are ignored; if you need a literal line break, use an `\n` in your string. The following two translations are equivalent: msgstr "This is a test translation" @@ -138,7 +138,7 @@ following two translations are equivalent: msgstr "" "This is a test translation" -If you want to test the translation (for example, the frontend one): +If you want to test the translation (for example, the front-end one): rm *.gmo stamp-po make @@ -147,14 +147,13 @@ If you want to test the translation (for example, the frontend one): Translating Manpages -------------------- - -There are currently no efforts underway to include translated manpages in the -pacman codebase. However, this is not to say translations are unwelcome. If -someone has experience with i18n manpages and how to best include them with our +There are currently no efforts underway to include translated manual pages in +the pacman codebase. However, this is not to say translations are unwelcome. If +someone has experience with i18n man pages and how to best include them with our source, please contact the pacman-dev mailing list at mailto:pacman-dev@archlinux.org[]. -Some community efforts have been made to translate manpages, and these can be +Some community efforts have been made to translate man pages, and these can be found in the link:https://aur.archlinux.org[AUR] (Arch User Repository). Please check there first before undergoing a translation effort to ensure you are not duplicating efforts. diff --git a/doc/vercmp.8.txt b/doc/vercmp.8.txt index 033e29f..5316b3c 100644 --- a/doc/vercmp.8.txt +++ b/doc/vercmp.8.txt @@ -31,7 +31,7 @@ Version comparison operates as follows: 1 < 1.0 < 1.1 < 1.1.1 < 1.2 < 2.0 < 3.0.0 Additionally, version strings can have an 'epoch' value defined that will -overrule any version comparison (unless the epoch values are equal). This is +overrule any version comparison, unless the epoch values are equal. This is specified in an `epoch:version-rel` format. For example, `2:1.0-1` is always greater than `1:3.6-1`. @@ -44,7 +44,7 @@ mainly for supporting versioned dependencies that do not include the 'pkgrel'. Options ------- *-h, \--help*:: - Display syntax for the given operation. If no operation was supplied + Display syntax for the given operation. If no operation was supplied, then the general syntax is shown. -- 2.0.4