ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-11-19 13:17:10 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
79259 commits 1 branch 0 tags 448 MiB
Commit graph

113 commits

Author SHA1 Message Date
Pierre Neidhardt
da31e7d9ec
doc: Link to "Building from Git" instead of quoting command to build Guix. 
* doc/contributing.texi (Submitting Patches): Remove example.
Add link to "Building from Git" section.
 2019-12-13 13:31:00 +01:00
Pierre Neidhardt
9fcf282058
doc: Mention how to simulate a `guix pull' before submitting patches. 
* doc/contributing.texi (Submitting Patches): Mention the dummy guix pull
  command in the check list.
 2019-12-08 16:34:32 +01:00
Pierre Neidhardt
bf99d7e0e2
doc: Mention how to rebuild guix before submitting patches. 
* doc/contributing.texi (Submitting Patches): Mention rebuild command in the
  check list.
 2019-12-08 16:32:34 +01:00
zimoun
0758a70cc0
doc: Mention value /var to localstatedir option. 
* README (Installing Guix from Guix): Mention value /var to localstatedir option.
* doc/contributing.texi (Building from Git): Likewise.
* doc/guix.texi (Requirements): Likewise.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2019-11-09 23:04:14 +01:00
Ludovic Courtès
8ba31e8bd1
doc: Use @lisp instead of @example for Scheme snippets. 
This is a followup to f8c143a713, which
allows syntax highlighting of @lisp snippets in the HTML output.

* doc/guix.texi, doc/contributing.texi: Use @lisp instead of @example
for all the Scheme snippets.
 2019-09-07 18:42:08 +02:00
Florian Pelz
0636742b77
doc: Reorder and clarify contributing instructions. 
* doc/contributing.texi (Building from Git, Running Guix Before It Is
Installed): Make instructions using Guix come first and clarify which code is
an instruction and which is merely an example.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2019-07-17 15:36:04 +02:00
Arne Babenhauserheide
fb8b99a5f5
doc: note how to install git send-email 
* doc/contributing.texi (git send-email): Add install instructions.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2019-07-15 12:48:49 +02:00
Tobias Geerinckx-Rice
44b5f28a77
doc: Remove references to hydra.gnu.org. 
* doc/contributing.texi (Packaging Guidelines, Submitting Patches):
Replace hydra URL with @value{SUBSTITUTE-SERVER}.
* doc/guix.texi (Official Substitute Server): Remove ‘hydra’ @cindex.
(Substitute Server Authorization): Remove note about hydra.gnu.org.pub.
 2019-06-29 06:28:50 +02:00
Giovanni Biscuolo
43ec98ef30
doc: use pure environment when building from git 
* doc/contributing.texi (Building from Git): Add --pure to "guix environment"
  invocations

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2019-05-20 23:23:01 +02:00
Efraim Flashner
b28e4e3c0d
doc: Remove instances of powerpc-linux being a supported Guix architecture. 
* doc/contributing.texi (Submitting Patches): Remove powerpc-linux
examples.
* doc/guix.texi (Virtualization Services): Replace powerpc-linux example
with mips64el-linux.
 2019-03-24 19:42:24 +02:00
Danny Milosavljevic
89339a35bd
doc: Document how to enable qemu binfmt service and how to use it. 
* doc/contributing.texi (Submitting Patches): Document how to enable qemu
binfmt service and how to use it.

Co-authored-by: Ricardo Wurmus <rekado@elephly.net>
 2019-02-04 17:56:28 +01:00
Ludovic Courtès
f73ab814a5
doc: Show how to install Emacs, Guile, and Geiser. 
* doc/contributing.texi (The Perfect Setup): Show "guix package -i"
command line.
 2019-02-04 00:03:30 +01:00
Ludovic Courtès
afe7408e19
doc: Move "Packaging Guidelines" under "Contributing". 
* doc/guix.texi (Packaging Guidelines): Move to...
* doc/contributing.texi (Packaging Guidelines): ... here.  Turn into a
section.  Adjust references to "Contributing".
 2019-01-22 23:04:06 +01:00
Pierre Neidhardt
0afeb7468c
doc: Replace @command by @code for packages 
* doc/contributing.texi (Submitting Patches): Replace @command by @code for
  packages.
 2018-12-15 19:21:08 +01:00
Pierre Neidhardt
024e358cb9
doc: Merge "discourage use of texlive" with existing paragraph on "guix size" 
* doc/contributing.texi (Submitting Patches): Merge "discourage use of
  texlive" with existing paragraph on "guix size".
 2018-12-15 00:20:35 +01:00
Pierre Neidhardt
dc56dc025d
doc: Discourage the use of texlive as input 
* doc/contributing.texi (Submitting Patches): Discourage the use of texlive as
  input.
 2018-12-14 23:32:39 +01:00
Ludovic Courtès
0bc02becca
Remove most references to hydra.gnu.org. 
* Makefile.am (assert-binaries-available): Don't mention hydra.gnu.org
in comment.
* build-aux/check-available-binaries.scm: Likewise.
* build-aux/check-final-inputs-self-contained.scm: Likewise.
* doc/guix.texi (SUBSTITUTE-SERVER): New variable.
Use it throughout instead of "mirror.hydra.gnu.org".
* doc/contributing.texi (Submitting Patches): Likewise.
* gnu/services/base.scm (hydra-key-authorization)
(guix-activation): Remove mentions of "hydra.gnu.org" in comments and
messages.
* gnu/system/install.scm (%installation-services): Likewise.
* guix/scripts/size.scm (guix-size): Likewise.
 2018-12-04 10:57:56 +01:00
Ludovic Courtès
bca6396749
doc: Mention that ./pre-inst-env is generated. 
Suggested by swedebugia <swedebugia@riseup.net>.

* doc/contributing.texi (Running Guix Before It Is Installed): Mention
that ./pre-inst-env is generated.
 2018-11-16 23:16:05 +01:00
Pierre Neidhardt
4feb589bf4
doc: Add recommendations for good origin URLs. 
* doc/contributing.texi (Submitting Patches): URL recommendations.
 2018-10-10 18:06:08 +02:00
Arun Isaac
9286c29504
etc: snippets: Add guix-commit-message-use-https-home-page. 
* etc/snippets/text-mode/guix-commit-message-use-https-home-page: New file.
* doc/contributing.texi (The Perfect Setup): Document new snippet.
 2018-07-13 12:45:11 +05:30
Ludovic Courtès
0207768fc9
doc: Mention the build environment. 
* doc/contributing.texi (Running Guix Before It Is Installed): Add a
note about having the dependencies available.
 2018-07-04 14:36:07 +02:00
Marius Bakke
38ab778fbd
doc: Clarify when branches are "frozen". 
* doc/contributing.texi (Submitting Patches): Provide a link to Hydra.  Add
section about freezing branches.
 2018-06-16 21:35:24 +02:00
Ludovic Courtès
75e24d7b0e
pull: Install the new Guix in a profile. 
* guix/scripts/pull.scm (%pull-version): New variable.
(build-from-source): Pass #:pull-version to BUILD.
(whole-package-for-legacy, derivation->manifest-entry): New procedure.
(build-and-install): Rewrite in terms of 'build-and-use-profile'.
* guix/scripts/system.scm (maybe-suggest-running-guix-pull)[latest]:
Switch to "/current".
* scripts/guix.in (augment-load-paths!): Remove use of
~/.config/guix/latest.
* build-aux/compile-as-derivation.scm: Replace "/guix/latest/" with
"/current/share/guile/site/X.Y"
* guix/scripts.scm (warn-about-old-distro)[age]: Check "/current"
instead of "/latest".
* doc/guix.texi (Invoking guix pull): Document it.
* doc/contributing.texi (Running Guix Before It Is Installed): Remove
footnote about abusing ~/.config/guix/latest.
 2018-06-09 12:02:27 +02:00
Ludovic Courtès
60912a888d
doc: Add tips for Vim users. 
* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
 2018-04-27 18:45:02 +02:00
Ludovic Courtès
67441b9a6e
doc: Suggest running guix-daemon with 'sudo -E'. 
Suggested by Martin H. <maze@strahlungsfrei.de>.

* doc/contributing.texi (Running Guix Before It Is Installed): Suggest
'sudo -E'.
 2018-01-17 15:48:22 -08:00
Ricardo Wurmus
42cdcdff19
etc: Add snippets. 
* etc/snippets/scheme-mode/guix-cvs-reference,
etc/snippets/scheme-mode/guix-git-reference,
etc/snippets/scheme-mode/guix-hg-reference,
etc/snippets/scheme-mode/guix-origin,
etc/snippets/scheme-mode/guix-package,
etc/snippets/scheme-mode/guix-svn-reference,
etc/snippets/text-mode/guix-commit-message-add-package,
etc/snippets/text-mode/guix-commit-message-update-package: New files.
* doc/contributing.texi (The Perfect Setup): Document snippets.
 2017-12-15 23:15:32 +01:00
Ricardo Wurmus
308c08d371
doc: Move paragraph about signature verification to the top. 
* doc/contributing.texi (Submitting Patches): Remind contributors to verify
cryptographic signatures at the very beginning.
 2017-11-08 17:19:45 +01:00
Jan Nieuwenhuizen
4619b59cb4
doc: Add a note about closing bug threads. 
* doc/contributing.texi (Submitting Patches): Add a note about closing bug
threads by mailing to NNN-done@debbugs.gnu.org.

Suggested-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
 2017-09-19 17:17:42 +02:00
Jan Nieuwenhuizen
5a183a1e2b
doc: Add "Sending a Patch Series" subsection. 
Searching for `git send-email' took you to the end of `Submitting Patches'
section which said

   You may use your email client or the ‘git send-email’ command.

without further warning or remark.

* doc/contributing.texi (Sending a Patch Series): Move information about
debbugs bug 15361 to subsection.  Add git-send-email index entries.
(Submitting Patches): Reference it.
 2017-09-19 17:17:34 +02:00
Leo Famulari
73a203450d
Revert "doc: Suggest running guix-daemon with 'sudo -E'." 
This change might not correct, so we revert it for now:

https://lists.gnu.org/archive/html/guix-devel/2017-08/msg00057.html

This reverts commit 6a4364335c.
 2017-08-07 14:09:49 -04:00
Ludovic Courtès
6a4364335c
doc: Suggest running guix-daemon with 'sudo -E'. 
Suggested by Martin H. <maze@strahlungsfrei.de>.

* doc/contributing.texi (Running Guix Before It Is Installed): Suggest
'sudo -E'.
 2017-08-06 00:03:45 +02:00
Ludovic Courtès
dbfcadfc30
doc: Show the "git clone" command. 
Suggested by Joshua Branson <jbranso91@gmail.com>.

* doc/contributing.texi (Building from Git): Add "git clone" command.
 2017-07-20 18:08:00 +02:00
Ricardo Wurmus
8ceffb2f34
doc: Encourage signature verification. 
* doc/contributing.texi (Submitting Patches): Remind contributors to verify
cryptographic signatures.
 2017-06-25 22:26:08 +02:00
Ludovic Courtès
916b5eba0d
doc: Document the branching and rebuild scheduling strategy. 
* doc/contributing.texi (Submitting Patches): Document the branching
scheme.
 2017-05-13 22:25:23 +02:00
Alex Kost
8ca0c88a89
doc: Add references to Emacs-Guix manual. 
* doc/htmlxref.cnf: Add links to the real manual.
* doc/contributing.texi (Formatting Code): Add reference to it.
* doc/guix.texi (Package Management): Likewise.
 2017-05-04 22:45:53 +03:00
Ludovic Courtès
230efa876f
doc: Update patch submission instructions. 
* doc/contributing.texi (Submitting Patches): Add paragraph on
guix-patches@gnu.org.
 2017-02-13 10:02:54 +01:00
Ludovic Courtès
557d9c8d7a
etc: Support indentation of whole files. 
* etc/indent-package.el.in: Rename to...
* etc/indent-code.el.in: ... this.  Add case for a single argument.
* doc/contributing.texi (Formatting Code): Adjust accordingly.
* configure.ac: Likewise.
 2017-01-13 18:49:31 +01:00
Ludovic Courtès
7bb2b10cd0
etc: Add 'indent-package.el' script. 
* configure.ac: Check for 'emacs', substitute 'EMACS', and emit
'etc/indent-package.el'.
* etc/indent-package.el.in: New file.
* doc/contributing.texi (Formatting Code): Mention
'etc/indent-package.el'.
(Submitting Patches): Likewise, and link to the above node.

Co-authored-by: Alex Kost <alezost@gmail.com>
 2017-01-12 14:56:52 +01:00
Alex Kost
deb6276dda
Remove Emacs interface. 
* emacs/guix-about.el: Remove file.
* emacs/guix-backend.el: Likewise.
* emacs/guix-base.el: Likewise.
* emacs/guix-buffer.el: Likewise.
* emacs/guix-build-log.el: Likewise.
* emacs/guix-command.el: Likewise.
* emacs/guix-config.el.in: Likewise.
* emacs/guix-devel.el: Likewise.
* emacs/guix-entry.el: Likewise.
* emacs/guix-external.el: Likewise.
* emacs/guix-geiser.el: Likewise.
* emacs/guix-guile.el: Likewise.
* emacs/guix-help-vars.el: Likewise.
* emacs/guix-helper.scm.in: Likewise.
* emacs/guix-history.el: Likewise.
* emacs/guix-hydra-build.el: Likewise.
* emacs/guix-hydra-jobset.el: Likewise.
* emacs/guix-hydra.el: Likewise.
* emacs/guix-info.el: Likewise.
* emacs/guix-init.el: Likewise.
* emacs/guix-license.el: Likewise.
* emacs/guix-list.el: Likewise.
* emacs/guix-location.el: Likewise.
* emacs/guix-main.scm: Likewise.
* emacs/guix-messages.el: Likewise.
* emacs/guix-pcomplete.el: Likewise.
* emacs/guix-popup.el: Likewise.
* emacs/guix-prettify.el: Likewise.
* emacs/guix-profiles.el: Likewise.
* emacs/guix-read.el: Likewise.
* emacs/guix-ui-generation.el: Likewise.
* emacs/guix-ui-license.el: Likewise.
* emacs/guix-ui-location.el: Likewise.
* emacs/guix-ui-package.el: Likewise.
* emacs/guix-ui-system-generation.el: Likewise.
* emacs/guix-ui.el: Likewise.
* emacs/guix-utils.el: Likewise.
* emacs/local.mk: Likewise.
* doc/emacs.texi: Likewise.
* doc/guix.texi: Remove cross-references to Emacs nodes.
(Package Management): Mention 'emacs-guix' package.
* doc/contributing.texi (The Perfect Setup): Remove the reference.
* doc/htmlxref.cnf: Add 'emacs-guix' URL.
* Makefile.am: Remove Emacs stuff.
* configure.ac: Likewise.
* gnu/packages/package-management.scm (guix-0.12.0)[native-inputs]:
Remove "emacs".
[propagated-inputs]: Remove "geiser" and "emacs-magit-popup".

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
 2016-12-29 23:40:24 +03:00
Maxim Cournoyer
089f385a21
doc: Fix typo in Submitting Patches section. 
* doc/contributing.texi (Submitting Patches): Fix "could could" typo.

Signed-off-by: Leo Famulari <leo@famulari.name>
 2016-12-14 14:57:50 -05:00
Ludovic Courtès
d222522edf
doc: Discourage software bundling. 
Fixes <http://bugs.gnu.org/24008>.
Suggested by ng0 <ng0@we.make.ritual.n0.is>.

* doc/contributing.texi (Submitting Patches): Add item about bundling.
 2016-07-28 15:41:00 +02:00
ng0
3a78fab83d
doc: Send changes in your patch which are related. 
* doc/contributing.texi (Submitting Patches): New @item:
This gives information about sending related changes and examples on
what we view as related changes.

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
 2016-07-28 15:38:14 +02:00
Ludovic Courtès
189b1543cb
doc: Mention separate branch for packages with many dependents. 
Suggested by ng0 <ng0@we.make.ritual.n0.is>.

* doc/contributing.texi (Submitting Patches): Add note on packages with
more than 100 dependents.
 2016-07-28 15:24:37 +02:00
ng0
0f53b886e2
doc: Point out preference of message format. 
* doc/contributing.texi (Submitting Patches): Includes a note on
preference of plain text messages with either inline or MIME attachments
and advise contributers to pay attention if their email client breaks the
patches.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2016-07-24 19:54:15 +02:00
Ludovic Courtès
dfcdd9c25d
doc: Explain that contributors can use a pseudonym. 
Suggested by ng0 <ng0@we.make.ritual.n0.is>.

* doc/contributing.texi (Contributing): Explain that using a legal name
is not required.
 2016-07-24 19:54:15 +02:00
Ludovic Courtès
3c2d03a2b9
doc: Add note on gender-neutral wording. 
Suggested by ng0 <ng0@we.make.ritual.n0.is>.

* doc/contributing.texi (Submitting Patches): Add @item regarding
gender-neutral wording.
 2016-07-22 15:26:49 +02:00
Ludovic Courtès
3a25c63120 doc: Mention --localstatedir for when building from Git. 
Reported by Hartmut Goebel <h.goebel@crazy-compilers.com>.

* doc/contributing.texi (Building from Git): Mention --localstatedir.
 2016-04-16 00:52:19 +02:00
Christopher Allan Webber
b5f990a680 doc: Add footnote about pointing ~/.config/guix/latest at user's checkout 
* doc/contributing.texi (Running Guix Before It Is Installed): New footnote.
 2016-03-11 08:41:07 -08:00
Chris Marusich
a40424bd11 doc: Fix minor typos and add missing words. 
* doc/guix.texi (Shepherd Services): Add missing words.
  (Invoking guix system): Fix typo.
  (Service Types and Services): Fix typo.
* doc/contributing.texi (Submitting Patches): Fix typo.

Signed-off-by: Andreas Enge <andreas@enge.fr>
 2016-02-24 21:34:30 +01:00
Alex Sassmannshausen
dcb7119a6d doc: rephrase code of conduct. 
* doc/contributing.texi (Contributing): Rephrase 'code of conduct'
  section.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
 2015-12-09 22:18:47 +01:00
Ludovic Courtès
e15fcdd149 Add "Contributor Covenant". 
* CODE-OF-CONDUCT: New file, adapted from
  <http://contributor-covenant.org/version/1/3/0/code_of_conduct.txt>.
* doc/contributing.texi (Contributing): Mention it.
* Makefile.am (EXTRA_DIST): Add it.
 2015-12-09 14:29:41 +01:00
Ludovic Courtès
5b74fe065b guix build: Add '--rounds'. 
* guix/scripts/build.scm (show-build-options-help)
(%standard-build-options): Add --rounds.
(set-build-options-from-command-line): Honor it.
* doc/guix.texi (Invoking guix build): Document it.
* doc/contributing.texi (Submitting Patches): Mention it.
 2015-12-08 23:58:12 +01:00
Ludovic Courtès
5fb95cc592 doc: Mention 'guix environment guix'. 
* doc/contributing.texi (Building from Git): Mention 'guix environment
guix'.  Remove outdated description of ./bootstrap.  Clarify a few
things.
 2015-11-22 14:14:25 +01:00
Ludovic Courtès
aabe6d3801 doc: Remove extraneous "See." 
* doc/contributing.texi (Building from Git): Remove extra "See" and use
@xref instead of @pxref.
 2015-11-21 22:26:13 +01:00
Alex Kost
bb38ece458 doc: Fix 'geiser-guile-load-path' example. 
Reported by marusich on #guix.

* doc/contributing.texi (The Perfect Setup): Wrap modifying
  'geiser-guile-load-path' into 'with-eval-after-load'.
 2015-11-21 02:19:04 +03:00
Alex Vong
ef54b61dc6 doc: './pre-inst-env guix pull' won't upgrade local source tree. 
* doc/contributing.texi (Running Guix Before It Is Installed): Clarify
  './pre-inst-env guix pull' won't upgrade local source tree.
* doc/guix.texi (Invoking guix pull): Mention ~/.config/guix/latest.

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
 2015-11-03 09:56:48 +01:00
Mark H Weaver
0431ed00e4 doc: Add texinfo to the requirements when building from git. 
* doc/contributing.texi (Building from Git): Add GNU Texinfo to the list of
  additional requirements.
 2015-10-28 12:04:02 +01:00
Ludovic Courtès
9685661324 doc: Add a REPL example. 
* doc/contributing.texi (Running Guix Before It Is Installed): Add REPL
  example.
* doc/emacs.texi (Emacs General info): Add @cindex.
 2015-10-27 00:01:20 +01:00
Ludovic Courtès
d23c20f1d0 Add 'guix challenge'. 
* guix/scripts/challenge.scm, tests/challenge.scm: New files.
* Makefile.am (MODULES): Add the former.
  (SCM_TESTS): Add the latter.
* doc.am (SUBCOMMANDS): Add 'challenge'.
* doc/guix.texi (Substitutes): Add xref to 'guix challenge'.
  (Invoking guix challenge): New node.
* doc/contributing.texi (Submitting Patches): Add note about using 'guix
  challenge'.
* po/guix/POTFILES.in: Add guix/scripts/challenge.scm.
 2015-10-20 00:57:36 +02:00
Alex Kost
187f80c6c5 emacs: Add development utils. 
* emacs/guix-guile.el (guix-guile-current-module): New function.
* emacs/guix-devel.el: New file.
* emacs.am (ELFILES): Add it.
* doc/emacs.texi (Emacs Development): New node.
  (Emacs Interface): Add it.
* doc/contributing.texi (The Perfect Setup): Mention it.
* doc/guix.texi (Top): Add it.
* emacs/guix-init.el: Add 'guix-devel-activate-mode-maybe' to
  'scheme-mode-hook'.
 2015-09-23 13:36:37 +03:00
Ludovic Courtès
cbd02397b5 doc: Add guidelines for synopses and descriptions. 
* doc/guix.texi (Synopses and Descriptions): New node.
* doc/contributing.texi (Submitting Patches): Add item that
  cross-references it.
 2015-09-15 22:48:52 +02:00
Ludovic Courtès
fcc58db68b Add 'guix size'. 
* guix/scripts/size.scm: New file.
* Makefile.am (MODULES): Add it.
  (SCM_TESTS): Add tests/size.scm.
* doc.am (SUBCOMMANDS): Add 'size'.
* po/guix/POTFILES.in: Add guix/scripts/size.scm.
* tests/size.scm: New file.
* doc/guix.texi (Packages with Multiple Outputs): Add xref to "Invoking guix
  size".
  (Invoking guix size): New node.
  (Invoking guix gc): Add index for "closure" and xref to the above.
* doc/contributing.texi (Submitting Patches): Use @enumerate for the check
  list.  Add item about 'guix size'.
 2015-06-18 00:36:09 +02:00
Mathieu Lirzin
8c01b9d05a doc: Move most 'HACKING' informations into the manual. 
* HACKING (Contributing): New section.
  (Building from Git, The Perfect Setup, Coding Style, Submitting Patches):
  Move to ...
* doc/guix.texi (Running Guix Before It Is Installed): Likewise.
* doc/contributing.texi: ... here. New file.
* doc.am (EXTRA_DIST): Use it.
* README (Installation): Adapt to it.
* configure.ac (DOT): Likewise.
 2015-06-14 01:44:54 +02:00