[pacman-dev] [PATCH 1/3] makepkg.conf(5): Add missing backticks around vars, and use single quotes around "gpg" command
Signed-off-by: Jason St. John
Signed-off-by: Jason St. John
On 17/01/14 09:30, Jason St. John wrote:
Signed-off-by: Jason St. John
--- doc/makepkg.conf.5.txt | 49 ++++++++++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index e43368c..c0e1e05 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -16,9 +16,9 @@ Synopsis
<snip>
@@ -255,8 +254,8 @@ Options
**PKGEXT=**".pkg.tar.gz", **SRCEXT=**".src.tar.gz":: Sets the compression used when making compiled or source packages. The - current valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, - `.tar.lzo`, `.tar.lrz` and `.tar.Z`. + current, valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, + `.tar.lzo`, `.tar.lrz`, and `.tar.Z`. Do not touch these unless you know what you are doing.
That sentence is still bad... How about just "Valid suffixes are ..."?
On Tue, Jan 28, 2014 at 12:07 PM, Allan McRae
On 17/01/14 09:30, Jason St. John wrote:
Signed-off-by: Jason St. John
<snip>
@@ -255,8 +254,8 @@ Options
**PKGEXT=**".pkg.tar.gz", **SRCEXT=**".src.tar.gz":: Sets the compression used when making compiled or source packages. The - current valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, - `.tar.lzo`, `.tar.lrz` and `.tar.Z`. + current, valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, + `.tar.lzo`, `.tar.lrz`, and `.tar.Z`. Do not touch these unless you know what you are doing.
That sentence is still bad... How about just "Valid suffixes are ..."?
I think the grammatically correct way to formulate the original meaning would be "currently valid suffixes are." That said, I don't think it matters that much which one is chosen since both of them are comprehensible.
Signed-off-by: Jason St. John
On Thu, Jan 16, 2014 at 5:30 PM, Jason St. John
Signed-off-by: Jason St. John
--- The correct path is "/opt", not "opt/". I assume "opt/" was written originally because the correct option to use is "opt/". This patch corrects the "/opt" vs. "opt/" issue and still provides an explicit example of using "opt/" in these variables.
I'm not sure that this actually clarifies anything. Most paths in makepkg docs and elsewhere are based on relative paths to $pkgdir. Also remember that you can use --rootdir in pacman to install things in places besides /, causing your new wording to not hold true. -1 without further explanation as to why has been wrong.
doc/makepkg.conf.5.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index c0e1e05..346e8e6 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -203,14 +203,14 @@ Options **MAN_DIRS=(**{usr{,/local}{,/share},opt/*}/{man,info} ...**)**:: If `zipman` is specified in the `OPTIONS` array, this variable will instruct makepkg where to look to compress manual (man and info) - pages. If you build packages that are located in opt/, you may need - to add the directory to this array. *NOTE:* Do not add the leading + pages. If you build packages that are located in `/opt`, you may need + to add `opt/` to this array. *NOTE:* Do not add the leading slash to the directory name.
**DOC_DIRS=(**usr/{,share/}{doc,gtk-doc} ...**)**:: If `!docs` is specified in the `OPTIONS` array, this variable will instruct makepkg where to look to remove docs. If you build packages - that are located in opt/, you may need to add the directory to this + that are located in `/opt`, you may need to add `opt/` to this array. *NOTE:* Do not add the leading slash to the directory name.
**PURGE_TARGETS=(**usr/{,share}/info/dir .podlist *.pod...**)**:: -- 1.8.5.3
On Sun, Jan 26, 2014 at 7:04 PM, Dan McGee
On Thu, Jan 16, 2014 at 5:30 PM, Jason St. John
wrote: Signed-off-by: Jason St. John
--- The correct path is "/opt", not "opt/". I assume "opt/" was written originally because the correct option to use is "opt/". This patch corrects the "/opt" vs. "opt/" issue and still provides an explicit example of using "opt/" in these variables. I'm not sure that this actually clarifies anything. Most paths in makepkg docs and elsewhere are based on relative paths to $pkgdir. Also remember that you can use --rootdir in pacman to install things in places besides /, causing your new wording to not hold true.
-1 without further explanation as to why has been wrong.
I'm fine with abandoning this patch for the reasons you provided. Jason
On Thu, Jan 16, 2014 at 5:30 PM, Jason St. John
Signed-off-by: Jason St. John
--- I left some of the references to CFLAGS, etc. without backticks because they are references to sections within the man page rather than about the literal variables themselves. I added backticks around "C/C++/ObjC" to prevent any possible confusion by AsciiDoc, as plus signs are parsed as AsciiDoc quotes. This apparently confused Vim's syntax highlighting, which is why I noticed it.
Is backticks the right thing for this string? I believe it becomes monospace in HTML output, which doesn't feel quite right. There might be another AsciiDoc quoting syntax that just does a passthrough literal that might be more appropriate, or do something like we do with the double-dash \-\-options flags.
doc/makepkg.conf.5.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index ef64d17..e43368c 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -78,7 +78,7 @@ Options Other flags that make accepts can also be passed.
**DEBUG_CFLAGS=**"debug_cflags":: - Additional compiler flags appended to CFLAGS for use in debugging. Usually + Additional compiler flags appended to `CFLAGS` for use in debugging. Usually this would include: ``-g''. Read gcc(1) for more details on the wide variety of compiler flags available.
@@ -96,7 +96,7 @@ Options Allow building packages as a non-root user. This is highly recommended.
*distcc*;; - Use the distributed C/C++/ObjC compiler to spread compilation among + Use the distributed `C/C++/ObjC` compiler to spread compilation among multiple machines. If this is enabled, `DISTCC_HOSTS` must be specified as well.
@@ -115,8 +115,8 @@ Options makepkg's '\--check' and '\--nocheck' options respectively.
*sign*;; - Generate a PGP signature file using GnuPG. This will execute `gpg - --detach-sign --use-agent` on the built package to generate a detached + Generate a PGP signature file using GnuPG. This will execute 'gpg + \--detach-sign \--use-agent' on the built package to generate a detached signature file, using the GPG agent if it is available. The signature file will be the entire filename of the package with a ``.sig'' extension. @@ -202,20 +202,20 @@ Options for details.
**MAN_DIRS=(**{usr{,/local}{,/share},opt/*}/{man,info} ...**)**:: - If `zipman` is specified in the OPTIONS array, this variable will + If `zipman` is specified in the `OPTIONS` array, this variable will instruct makepkg where to look to compress manual (man and info) pages. If you build packages that are located in opt/, you may need to add the directory to this array. *NOTE:* Do not add the leading slash to the directory name.
**DOC_DIRS=(**usr/{,share/}{doc,gtk-doc} ...**)**:: - If `!docs` is specified in the OPTIONS array, this variable will + If `!docs` is specified in the `OPTIONS` array, this variable will instruct makepkg where to look to remove docs. If you build packages that are located in opt/, you may need to add the directory to this array. *NOTE:* Do not add the leading slash to the directory name.
**PURGE_TARGETS=(**usr/{,share}/info/dir .podlist *.pod...**)**:: - If `purge` is specified in the OPTIONS array, this variable will + If `purge` is specified in the `OPTIONS` array, this variable will instruct makepkg which files to remove from the package. This is useful for index files that are added by multiple packages.
-- 1.8.5.3
participants (4)
-
Allan McRae
-
Dan McGee
-
Jason St. John
-
Silvan Jegen