| Message ID | V47ZnK0iG7rVhoANkeFQKW-DIt3r_nrLbszBhIOa5mJof5UDTPq8RVGzermLPM6z5fCtueHol307rA4fJ9maNWnI0YtlbdV42xPf_uIT3u8=@protonmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation | expand |
| Context | Check | Description |
|---|---|---|
| cbaines/comparison | success | View comparision |
| cbaines/git branch | success | View Git branch |
| cbaines/applying patch | fail | View Laminar job |
| cbaines/issue | success | View issue |
Hi Dissent, Great to see that you sent the patch that we worked on from the guix packaging meetup. To add more stuff to your commit I recommend the following workflow: 1. Make additional changes to the cookbook file. 2. guix shell texi2html -- texi2html doc/guix-cookbook.texi 3. Open and check the generated html file with your web browser. 4. git add doc/guix-cookbook.texi 5. git commit --amend --no-edit 6. git format-patch -1 7. email patch again to 51538@debbugs.gnu.org With the above workflow I recommend adding an entry in the TOC for the FAQ section. Note that `git format-patch -1` only takes the last commit so if you add more commits you'll need to adjust that command. `git commit --amend --no-edit` does not open your editor to modify your commit message. If you'd like to then remove `--no-edit`. Another guix contributor might prefer that section to be called something else or not so let's wait to hear from others. I don't have commit access so someone else will have to review your changes also and merge them. all best, jgart
Thanks for the comments Florian,
Added periods and removed whitespace.
In my initial Guix setup I was unable to clear the terminal with neither `clear` nor C-l. Installing ncurses solved that issue and is listed as a dependency for GNU Readline.
I was able to build the html just fine before I submitted it. Upon rebuilding, the html appears fine but still getting those errors. I then decided to just clone the guix repo again without making any changes to the .texi but attempting to create the html still produced those errors.
It seems this is the issue:
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.32), passed through in regex; marked by <-- HERE in m/^\s+@([^\s\{\}\@]+)({ <-- HERE })?\s*/ at /gnu/store/nxqw880l3r5z0dl6nrlf75mr0z0v70vp-profile/bin/texi2html line 33246.
Not sure how to proceed from here.
The new patch has been submited
Disseminate,
Peace
I just wanted to mention that roptat added a nice entry for texinfo in learnxinyminutes series of sites: https://github.com/adambard/learnxinyminutes-docs/pull/4263 Hopefully it will get merged soon. I think this will help with lowering the barrier to entry for learning Texinfo as well as serve as a quick TLDR reference.
From 9af25ebde3baaa76b28bbde97bc48640476911f5 Mon Sep 17 00:00:00 2001 From: dissent <disseminatedissent@protonmail.com> Date: Sat, 30 Oct 2021 17:00:02 -0400 Subject: [PATCH] doc: Added FAQ section with entry on using clear. * doc/guix-cookbook.texi: Added FAQ section. --- doc/guix-cookbook.texi | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi index dc52f6d38c..bdbf83f900 100644 --- a/doc/guix-cookbook.texi +++ b/doc/guix-cookbook.texi @@ -2964,6 +2964,21 @@ will have predefined environment variables and procedures. Run @command{direnv allow} to setup the environment for the first time. +@c ********************************************************************* +@node FAQ +@chapter FAQ + +This chapter collects some frequently asked questions that might arise for new users. + +@menu +* How do I clear my terminal screen? +@end menu + +@node How do I clear my terminal screen? +@section How do I clear my terminal screen? + +The @command{clear} command is found in the @command{ncurses} package. + @c ********************************************************************* @node Acknowledgments @chapter Acknowledgments -- 2.20.1