[bug#33318] doc: Add cindex & command to show versions of dependencies

Message ID 3daf961d-eab0-305f-b6e3-76f38b0643da@riseup.net
State New
Headers show
Series
  • [bug#33318] doc: Add cindex & command to show versions of dependencies
Related show

Checks

Context Check Description
cbaines/applying patch success Successfully applied

Commit Message

swedebugia Nov. 8, 2018, 4 p.m. UTC
Hi

Here is my first patch!

Comments

swedebugia Jan. 3, 2019, 4:21 p.m. UTC | #1
On 2018-11-08 17:00, swedebugia wrote:
> Hi
> 
> Here is my first patch!
> 

Ping

Patch

From 331dfcdcdf75f943f2395fe829703726200cbb5b Mon Sep 17 00:00:00 2001
From: swedebugia <swedebugia@riseup.net>
Date: Thu, 8 Nov 2018 16:14:06 +0100
Subject: [PATCH] doc: Add cindex & command to show versions of dependencies

* doc/guix.texi: Add 2 cindex in 2 sections
* doc/guix.texi (Running the Test Suite): Add command to show versions of dependencies
---
 doc/guix.texi | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 441b65bca..0b906edc1 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -52,6 +52,7 @@  Copyright @copyright{} 2018 Pierre-Antoine Rouby@*
 Copyright @copyright{} 2018 Gábor Boskovits@*
 Copyright @copyright{} 2018 Florian Pelz@*
 Copyright @copyright{} 2018 Laura Lazzati@*
+Copyright @copyright{} 2018 swedebugia@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -602,6 +603,7 @@  would find yourself badly handicapped by the lack of the @command{guix}
 command.  In other words, do not remove @code{guix} by running
 @code{guix package -r guix}.
 
+@cindex producing the binary guix tarball
 The binary installation tarball can be (re)produced and verified simply
 by running the following command in the Guix source tree:
 
@@ -743,8 +745,15 @@  make check TESTS="tests/base64.scm" SCM_LOG_DRIVER_FLAGS="--brief=no"
 Upon failure, please email @email{bug-guix@@gnu.org} and attach the
 @file{test-suite.log} file.  Please specify the Guix version being used
 as well as version numbers of the dependencies (@pxref{Requirements}) in
-your message.
+your message, e.g. by running this command:
 
+@example
+guile --version | head -1 && guix --version | head -1 && \
+gcc --version | head -1 && echo -n ``libgcrypt `` && \
+libgcrypt-config --version && make --version | head -1
+@end example
+
+@cindex whole-system test suite
 Guix also comes with a whole-system test suite that tests complete
 GuixSD operating system instances.  It can only run on systems where
 Guix is already installed, using:
-- 
2.18.0