[PATCH 0/1] Borg: Install more docs

[PATCH 0/1] Borg: Install more docs

[Leo Famulari]

These text files explain in greater detail some things that are
explained in the Borg man page. You could think of them as extended
examples. The visual explanation of pruning was especially helpful to
me.

This method of selecting the files is crude. Originally I used
(find-files "docs/misc" "\\.txt$"), but that picked up some unwanted
files in 'docs/misc/asciinema'. Any suggestions for improvement?

Leo Famulari (1):
  gnu: borg: Install more documentation.

 gnu/packages/backup.scm | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

-- 
2.10.1

[PATCH 1/1] gnu: borg: Install more documentation.

[Leo Famulari]

* gnu/packages/backup.scm (borg)[arguments]: Install more documentation
in 'install-doc' phase.
---
 gnu/packages/backup.scm | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/backup.scm b/gnu/packages/backup.scm
index eb5e98d..b75e99b 100644
--- a/gnu/packages/backup.scm
+++ b/gnu/packages/backup.scm
@@ -439,8 +439,15 @@ detection, and lossless compression.")
          (add-after 'install 'install-doc
            (lambda* (#:key outputs #:allow-other-keys)
              (let* ((out (assoc-ref outputs "out"))
-                    (man (string-append out "/share/man/man1")))
+                    (man (string-append out "/share/man/man1"))
+                    (misc (string-append out "/share/borg/misc")))
                (and
+                 (for-each (lambda (file)
+                             (install-file file misc))
+                           (find-files "docs/misc"
+                                       (string-append "create_chunker-params|"
+                                                      "internals-picture|"
+                                                      "prune-example")))
                  (zero? (system* "python3" "setup.py" "build_ext" "--inplace"))
                  (zero? (system* "make" "-C" "docs" "man"))
                  (begin
-- 
2.10.1

Re: [PATCH 1/1] gnu: borg: Install more documentation.

[Ricardo Wurmus]

Leo Famulari <leo@famulari.name> writes:

> * gnu/packages/backup.scm (borg)[arguments]: Install more documentation
> in 'install-doc' phase.
> ---
>  gnu/packages/backup.scm | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/gnu/packages/backup.scm b/gnu/packages/backup.scm
> index eb5e98d..b75e99b 100644
> --- a/gnu/packages/backup.scm
> +++ b/gnu/packages/backup.scm
> @@ -439,8 +439,15 @@ detection, and lossless compression.")
>           (add-after 'install 'install-doc
>             (lambda* (#:key outputs #:allow-other-keys)
>               (let* ((out (assoc-ref outputs "out"))
> -                    (man (string-append out "/share/man/man1")))
> +                    (man (string-append out "/share/man/man1"))
> +                    (misc (string-append out "/share/borg/misc")))
>                 (and
> +                 (for-each (lambda (file)
> +                             (install-file file misc))

I like “cut” from srfi-26 in simple cases like this:

    (for-each (cut install-file <> misc)
              (find-files …))

> +                           (find-files "docs/misc"
> +                                       (string-append "create_chunker-params|"
> +                                                      "internals-picture|"
> +                                                      "prune-example")))

I don’t think “string-append” is needed here.  You can just break the
string and escape the line break.

~~ Ricardo

Re: [PATCH 1/1] gnu: borg: Install more documentation.

[Alex Kost]

Leo Famulari (2016-10-17 23:03 -0400) wrote:

> * gnu/packages/backup.scm (borg)[arguments]: Install more documentation
> in 'install-doc' phase.
> ---
>  gnu/packages/backup.scm | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/gnu/packages/backup.scm b/gnu/packages/backup.scm
> index eb5e98d..b75e99b 100644
> --- a/gnu/packages/backup.scm
> +++ b/gnu/packages/backup.scm
> @@ -439,8 +439,15 @@ detection, and lossless compression.")
>           (add-after 'install 'install-doc
>             (lambda* (#:key outputs #:allow-other-keys)
>               (let* ((out (assoc-ref outputs "out"))
> -                    (man (string-append out "/share/man/man1")))
> +                    (man (string-append out "/share/man/man1"))
> +                    (misc (string-append out "/share/borg/misc")))
>                 (and
> +                 (for-each (lambda (file)

Note that the return value of 'for-each' is not specified, so it should
not be used inside 'and'.  I would just put it before (and (zero? …) …).

> +                             (install-file file misc))
> +                           (find-files "docs/misc"
> +                                       (string-append "create_chunker-params|"
> +                                                      "internals-picture|"
> +                                                      "prune-example")))
>                   (zero? (system* "python3" "setup.py" "build_ext" "--inplace"))
>                   (zero? (system* "make" "-C" "docs" "man"))
>                   (begin

-- 
Alex

Re: [PATCH 1/1] gnu: borg: Install more documentation.

[Leo Famulari]

On Tue, Oct 18, 2016 at 09:19:19AM +0200, Ricardo Wurmus wrote:
> 
> Leo Famulari <leo@famulari.name> writes:
> 
> > * gnu/packages/backup.scm (borg)[arguments]: Install more documentation
> > in 'install-doc' phase.
> > ---
> >  gnu/packages/backup.scm | 9 ++++++++-
> >  1 file changed, 8 insertions(+), 1 deletion(-)
> >
> > diff --git a/gnu/packages/backup.scm b/gnu/packages/backup.scm
> > index eb5e98d..b75e99b 100644
> > --- a/gnu/packages/backup.scm
> > +++ b/gnu/packages/backup.scm
> > @@ -439,8 +439,15 @@ detection, and lossless compression.")
> >           (add-after 'install 'install-doc
> >             (lambda* (#:key outputs #:allow-other-keys)
> >               (let* ((out (assoc-ref outputs "out"))
> > -                    (man (string-append out "/share/man/man1")))
> > +                    (man (string-append out "/share/man/man1"))
> > +                    (misc (string-append out "/share/borg/misc")))
> >                 (and
> > +                 (for-each (lambda (file)
> > +                             (install-file file misc))
> 
> I like “cut” from srfi-26 in simple cases like this:
> 
>     (for-each (cut install-file <> misc)
>               (find-files …))

Thanks, that is easier to read.

> > +                           (find-files "docs/misc"
> > +                                       (string-append "create_chunker-params|"
> > +                                                      "internals-picture|"
> > +                                                      "prune-example")))
> 
> I don’t think “string-append” is needed here.  You can just break the
> string and escape the line break.

I decided not to use a regex for this. It's only three files so I just
used a list.

Re: [PATCH 1/1] gnu: borg: Install more documentation.

[Leo Famulari]

On Tue, Oct 18, 2016 at 07:47:53PM +0300, Alex Kost wrote:
> Leo Famulari (2016-10-17 23:03 -0400) wrote:
> 
> > * gnu/packages/backup.scm (borg)[arguments]: Install more documentation
> > in 'install-doc' phase.
> > ---
> >  gnu/packages/backup.scm | 9 ++++++++-
> >  1 file changed, 8 insertions(+), 1 deletion(-)
> >
> > diff --git a/gnu/packages/backup.scm b/gnu/packages/backup.scm
> > index eb5e98d..b75e99b 100644
> > --- a/gnu/packages/backup.scm
> > +++ b/gnu/packages/backup.scm
> > @@ -439,8 +439,15 @@ detection, and lossless compression.")
> >           (add-after 'install 'install-doc
> >             (lambda* (#:key outputs #:allow-other-keys)
> >               (let* ((out (assoc-ref outputs "out"))
> > -                    (man (string-append out "/share/man/man1")))
> > +                    (man (string-append out "/share/man/man1"))
> > +                    (misc (string-append out "/share/borg/misc")))
> >                 (and
> > +                 (for-each (lambda (file)
> 
> Note that the return value of 'for-each' is not specified, so it should
> not be used inside 'and'.  I would just put it before (and (zero? …) …).

Thanks, I've taken that into account.