[pacman-dev] [PATCH 1/2] doc: clarify the format of a PKGBUILD source fragment
Currently, it could be misread to say that a fragment is literally 'commit', rather than 'commit=somehash'. Anecdotally this does not seem to be obvious to everyone, and rewording it certainly doesn't hurt. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> --- doc/PKGBUILD.5.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/PKGBUILD.5.asciidoc b/doc/PKGBUILD.5.asciidoc index bc5aa011..27d56a67 100644 --- a/doc/PKGBUILD.5.asciidoc +++ b/doc/PKGBUILD.5.asciidoc @@ -496,9 +496,9 @@ The source URL is divided into four components: *fragment*:: (optional) Allows specifying a revision number or branch for makepkg to checkout - from the VCS. For example, to checkout a given revision, the source line would - have the format `source=(url#revision=123)`. The available fragments depends on - the VCS being used: + from the VCS. A fragment has the form `type=value`, for example to checkout a + given revision the source line would be `source=(url#revision=123)`. The + available types depends on the VCS being used: *bzr*;; revision (see `'bzr help revisionspec'` for details) -- 2.24.1
It's difficult to find it embedded inside a prose paragraph. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> --- doc/PKGBUILD.5.asciidoc | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/PKGBUILD.5.asciidoc b/doc/PKGBUILD.5.asciidoc index 27d56a67..b170a812 100644 --- a/doc/PKGBUILD.5.asciidoc +++ b/doc/PKGBUILD.5.asciidoc @@ -474,11 +474,13 @@ reference with all of the available functions defined. Using VCS Sources[[VCS]] ------------------------ Building a developmental version of a package using sources from a version -control system (VCS) is enabled by specifying the source in the form -`source=('directory::url#fragment?query')`. Currently makepkg supports the -Bazaar, Git, Subversion, and Mercurial version control systems. For other -version control systems, manual cloning of upstream repositories must be done -in the `prepare()` function. +control system (VCS) is enabled by specifying the source in the form: + + source=('directory::url#fragment?query') + +Currently makepkg supports the Bazaar, Git, Subversion, and Mercurial version +control systems. For other version control systems, manual cloning of upstream +repositories must be done in the `prepare()` function. The source URL is divided into four components: -- 2.24.1
participants (1)
-
Eli Schwartz