guix-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

01/02: doc: Fix typos.


From: guix-commits
Subject: 01/02: doc: Fix typos.
Date: Sun, 24 Nov 2024 06:57:04 -0500 (EST)

pelzflorian pushed a commit to branch master
in repository guix.

commit 745943d253b5fc4ac850fb8851e2b398ac673c33
Author: Florian Pelz <pelzflorian@pelzflorian.de>
AuthorDate: Sat Nov 23 22:34:40 2024 +0100

    doc: Fix typos.
    
    * doc/contributing.texi (Commit Access): Use @xref when beginning a
    sentence.
    * doc/guix.texi (package Reference): Likewise.
    (Invoking guix gc): Add missing words.
    (Invoking guix pack): Likewise.
    (Specifying Channel Authorizations): Move period after closing parenthesis.
    (origin Reference)[git-fetch, git-fetch/lfs]: Add missing optional argument.
    [svn-reference]: Add missing ‘the’.
    
    Change-Id: I8a5e475e928200299117e55274847319eeda8bdb
---
 doc/contributing.texi |  2 +-
 doc/guix.texi         | 22 +++++++++++-----------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 8b9aa82bc8..b063169189 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -2743,7 +2743,7 @@ contributor is willing to take to help the project.
 
 Committers are in a position where they enact technical decisions.  Such
 decisions must be made by @emph{actively building consensus} among
-interested parties and stakeholders.  @ref{Making Decisions}, for more
+interested parties and stakeholders.  @xref{Making Decisions}, for more
 on that.
 
 The following sections explain how to get commit access, how to be ready
diff --git a/doc/guix.texi b/doc/guix.texi
index 5953fcfa26..3ca8629aef 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4383,11 +4383,11 @@ this option is primarily useful when the daemon was 
running with
 @item --vacuum-database
 @cindex vacuum the store database
 @comment Avoid words like 'repair,' 'compress,' and 'optimize.'
-Guix uses an sqlite database to keep track of the items in (@pxref{The Store}).
-Over time it is possible that the database may grow to a large size and become
-fragmented.  As a result, one may wish to clear the freed space and join the
-partially used pages in the database left behind from removed packages or after
-running the garbage collector.  Running @command{sudo guix gc
+Guix uses an sqlite database to keep track of the items in the store
+(@pxref{The Store}).  Over time it is possible that the database may grow to a
+large size and become fragmented.  As a result, one may wish to clear the freed
+space and join the partially used pages in the database left behind from 
removed
+packages or after running the garbage collector.  Running @command{sudo guix gc
 --vacuum-database} will lock the database and @code{VACUUM} the store,
 defragmenting the database and purging freed pages, unlocking the database when
 it finishes.
@@ -5764,7 +5764,7 @@ named @code{keyring} (we recommend making it an 
@dfn{orphan branch}).
 @item
 Introduce an initial @file{.guix-authorizations} in the channel's
 repository.  Do that in a signed commit (@pxref{Commit Access}, for
-information on how to sign Git commits.)
+information on how to sign Git commits).
 
 @item
 Advertise the channel introduction, for instance on your channel's web
@@ -7359,7 +7359,7 @@ profile---by default @var{name} is @code{guix-profile}, 
which corresponds to
 @file{/var/guix} contains the store database (@pxref{The Store}) as well
 as garbage-collector roots (@pxref{Invoking guix gc}).  Providing it in
 the pack means that the store is ``complete'' and manageable by Guix;
-not providing it pack means that the store is ``dead'': items cannot be
+not providing it in the pack means that the store is ``dead'': items cannot be
 added to it or removed from it after extraction of the pack.
 
 One use case for this is the Guix self-contained binary tarball
@@ -8124,7 +8124,7 @@ The build tool chain is part of the @dfn{implicit inputs} 
of
 packages---it's usually not listed as part of the various ``inputs''
 fields and is instead pulled in by the build system.  Consequently, this
 procedure works by changing the build system of @var{package} so that it
-pulls in @var{toolchain} instead of the defaults.  @ref{Build Systems},
+pulls in @var{toolchain} instead of the defaults.  @xref{Build Systems},
 for more on build systems.
 @end deffn
 
@@ -8263,14 +8263,14 @@ Likewise, the @code{(guix git-download)} module defines 
the
 control repository, and the @code{git-reference} data type to describe
 the repository and revision to fetch.
 
-@deffn {Procedure} git-fetch ref hash-algo hash
+@deffn {Procedure} git-fetch ref hash-algo hash [name]
 Return a fixed-output derivation that fetches @var{ref}, a
 @code{<git-reference>} object.  The output is expected to have recursive
 hash @var{hash} of type @var{hash-algo} (a symbol).  Use @var{name} as
 the file name, or a generic name if @code{#f}.
 @end deffn
 
-@deffn {Procedure} git-fetch/lfs ref hash-algo hash
+@deffn {Procedure} git-fetch/lfs ref hash-algo hash [name]
 This is a variant of the @code{git-fetch} procedure that supports the
 Git @acronym{LFS, Large File Storage} extension.  This may be useful to
 pull some binary test data to run the test suite of a package, for
@@ -8358,7 +8358,7 @@ retrieve.
 The URL of the Subversion repository to clone.
 
 @item @code{revision}
-This string denotes revision to fetch specified as a number.
+This string denotes the revision to fetch specified as a number.
 
 @item @code{recursive?} (default: @code{#f})
 This Boolean indicates whether to recursively fetch Subversion



reply via email to

[Prev in Thread] Current Thread [Next in Thread]