[pacman-dev,1/2] doc: clarify the format of a PKGBUILD source fragment

Message ID 20191225025958.908461-1-eschwartz@archlinux.org
State Accepted, archived
Headers show
Series [pacman-dev,1/2] doc: clarify the format of a PKGBUILD source fragment | expand

Commit Message

Eli Schwartz Dec. 25, 2019, 2:59 a.m. UTC
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(-)

Patch

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)