[bug#28127] [PATCH] Add documentation for NGinx

[bug#28127] [PATCH] Add documentation for NGinx

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 259 bytes --]


Christopher Baines (2):
  perl: Add perl-parse-recdescent.
  web: Add NGinx documentation.

 gnu/packages/perl.scm | 25 +++++++++++++
 gnu/packages/web.scm  | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 123 insertions(+)

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

[bug#28127] [PATCH 1/2] perl: Add perl-parse-recdescent.

[Christopher Baines]

* gnu/packages/perl.scm (perl-parse-recdescent): New variable.
---
 gnu/packages/perl.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/perl.scm b/gnu/packages/perl.scm
index 3265a55f0..b05b4d8bc 100644
--- a/gnu/packages/perl.scm
+++ b/gnu/packages/perl.scm
@@ -8375,3 +8375,28 @@ interface to File::Find::Object.")
   (description "Test::TrailingSpace tests for trailing spaces
 in Perl source files.")
   (license x11)))
+
+(define-public perl-parse-recdescent
+  (package
+    (name "perl-parse-recdescent")
+    (version "1.967015")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append
+             "mirror://cpan/authors/id/J/JT/JTBRAUN/Parse-RecDescent-"
+             version
+             ".tar.gz"))
+       (sha256
+        (base32
+         "0dvfcn2xvj9r4ra5xqgasl847nsm1iy85w1kly41fkxm9im36hqr"))))
+    (build-system perl-build-system)
+    (native-inputs
+     `(("perl-module-build" ,perl-module-build)))
+    (home-page
+     "http://search.cpan.org/dist/Parse-RecDescent")
+    (synopsis "Generate Recursive-Descent Parsers")
+    (description
+     "Parse::RecDescent can incrementally generate top-down recursive-descent
+text parsers from simple yacc-like grammar specifications.")
+    (license (package-license perl))))
-- 
2.14.1

[bug#28127] [PATCH 2/2] web: Add NGinx documentation.

[Christopher Baines]

* gnu/packages/web.scm (nginx): Add comment about deleting the documentation.
  (nginx-xslscript): New variable.
  (nginx-docs): New variable.
---
 gnu/packages/web.scm | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)

diff --git a/gnu/packages/web.scm b/gnu/packages/web.scm
index 6eb9833f2..5e58ad3f8 100644
--- a/gnu/packages/web.scm
+++ b/gnu/packages/web.scm
@@ -43,6 +43,7 @@
   #:use-module (guix download)
   #:use-module (guix git-download)
   #:use-module (guix cvs-download)
+  #:use-module (guix hg-download)
   #:use-module (guix utils)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system glib-or-gtk)
@@ -134,6 +135,8 @@ and its related documentation.")
 (define-public nginx
   (package
     (name "nginx")
+    ;; Consider updating the nginx-docs package if the nginx package is
+    ;; updated.
     (version "1.12.1")
     (source (origin
               (method url-fetch)
@@ -212,6 +215,101 @@ and as a proxy to reduce the load on back-end HTTP or mail servers.")
     ;;     except for two source files which are bsd-4 licensed.
     (license (list l:bsd-2 l:expat l:bsd-3 l:bsd-4))))
 
+(define nginx-xslscript
+  (let ((revision 11)
+        (changeset "01dc9ba12e1b"))
+    (package
+      (name "nginx-xslscript")
+      (version
+       (simple-format #f "2014-03-31-~A-~A" revision changeset))
+      (source (origin
+                (method hg-fetch)
+                (uri (hg-reference
+                      (url "http://hg.nginx.org/xslscript")
+                      (changeset changeset)))
+                (file-name (string-append name "-" version))
+                (sha256
+                 (base32
+                  "0am8zvdx3jmiwkg5q07qjaw5r26r4i2v5i4yr8a1k0jgib6ii08g"))))
+      (build-system gnu-build-system)
+      (arguments
+       '(#:tests? #f  ; No test suite
+         #:phases
+         (modify-phases %standard-phases
+           (delete 'configure)
+           (delete 'build)
+           (replace 'install
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((out-bin (string-append
+                               (assoc-ref outputs "out")
+                               "/bin")))
+                 (mkdir-p out-bin)
+                 (copy-file "xslscript.pl"
+                            (string-append
+                             out-bin
+                             "/xslscript.pl"))
+                 #t))))))
+      (home-page "http://hg.nginx.org/xslscript")
+      (synopsis "XSLScript with NGinx specific modifications")
+      (description
+       "XSLScript is a terse notation for writing complex XSLT stylesheets.
+This is modified version, specifically intended for use with the NGinx
+documentation.")
+      (license l:bsd-2))))
+
+(define-public nginx-docs
+  ;; This documentation should be relevant for nginx-1.12.0
+  (let ((revision 1961)
+        (changeset "dd4b6c564e10"))
+    (package
+      (name "nginx-docs")
+      (version
+       (simple-format #f "2017-04-12-~A-~A" revision changeset))
+      (source
+       (origin (method hg-fetch)
+               (uri (hg-reference
+                     (url "http://hg.nginx.org/nginx.org")
+                     (changeset changeset)))
+               (file-name (string-append name "-" version))
+               (sha256
+                (base32
+                 "0rycfnnm2xkm777769h1zib428q45j64mx8nzzfzs4v07jbfc8m5"))))
+      (build-system gnu-build-system)
+      (arguments
+       '(#:tests? #f  ; No test suite
+         #:phases
+         (modify-phases %standard-phases
+           (delete 'configure)
+           (replace 'build
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((output (assoc-ref outputs "out")))
+                 (substitute* "umasked.sh"
+                   ((" /bin/sh") (string-append " " (which "sh"))))
+                 ;; The documentation includes a banner, which makes sense on
+                 ;; the NGinx website, but doesn't make much sense when
+                 ;; viewing locally. Therefore, modify the CSS to remove the
+                 ;; banner.
+                 (substitute* "xslt/style.xslt"
+                   (("#banner           \\{ background:     black;")
+                    "#banner           { background:     black;
+                            display:     none;"))
+                 (zero? (system* "make")))))
+           (replace 'install
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((output (assoc-ref outputs "out")))
+                 (mkdir-p output)
+                 (copy-recursively "libxslt" output)
+                 #t))))))
+      (native-inputs
+       `(("libxml2" ,libxml2)
+         ("libxslt" ,libxslt)
+         ("nginx-xslscript" ,nginx-xslscript)))
+      (home-page "https://nginx.org")
+      (synopsis "Documentation for NGinx")
+      (description
+       "The documentation for the NGinx web server.")
+      (license l:bsd-2))))
+
 (define-public fcgi
   (package
     (name "fcgi")
-- 
2.14.1

[bug#28127] [PATCH 2/2] web: Add NGinx documentation.

[Ludovic Courtès]

Christopher Baines <mail@cbaines.net> skribis:

> * gnu/packages/web.scm (nginx): Add comment about deleting the documentation.
>   (nginx-xslscript): New variable.
>   (nginx-docs): New variable.

That’s a good idea!

> +(define-public nginx-docs
> +  ;; This documentation should be relevant for nginx-1.12.0
> +  (let ((revision 1961)
> +        (changeset "dd4b6c564e10"))
> +    (package
> +      (name "nginx-docs")

Maybe “nginx-doc” (singular)?

> +      (home-page "https://nginx.org")
> +      (synopsis "Documentation for NGinx")
> +      (description
> +       "The documentation for the NGinx web server.")

“This package provides HTML documentation for the NGINX web server.” (?)

Also, s/NGinx/NGINX/ if I’m not mistaken.

Thanks!

Ludo’.

[bug#28127] [PATCH 2/2] web: Add NGinx documentation.

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 1211 bytes --]

On Wed, 04 Oct 2017 16:48:13 +0200
ludo@gnu.org (Ludovic Courtès) wrote:

> Christopher Baines <mail@cbaines.net> skribis:
> 
> > * gnu/packages/web.scm (nginx): Add comment about deleting the
> > documentation. (nginx-xslscript): New variable.
> >   (nginx-docs): New variable.  
> 
> That’s a good idea!
> 
> > +(define-public nginx-docs
> > +  ;; This documentation should be relevant for nginx-1.12.0
> > +  (let ((revision 1961)
> > +        (changeset "dd4b6c564e10"))
> > +    (package
> > +      (name "nginx-docs")  
> 
> Maybe “nginx-doc” (singular)?

I wasn't sure about nginx-doc, so I have sent an updated patch using
nginx-documentation. 

> > +      (home-page "https://nginx.org")
> > +      (synopsis "Documentation for NGinx")
> > +      (description
> > +       "The documentation for the NGinx web server.")  
> 
> “This package provides HTML documentation for the NGINX web
> server.” (?)
> 
> Also, s/NGinx/NGINX/ if I’m not mistaken.

I haven't seen any guidance on this, but the documentation itself uses
nginx (all lower case) as far as I can see, so I've switched to using
that.

I've sent an updated patch, thanks for your review :)

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

[bug#28127] [PATCH 1/2] perl: Add perl-parse-recdescent.

[Ludovic Courtès]

Christopher Baines <mail@cbaines.net> skribis:

> * gnu/packages/perl.scm (perl-parse-recdescent): New variable.

[...]

> +    (home-page
> +     "http://search.cpan.org/dist/Parse-RecDescent")
> +    (synopsis "Generate Recursive-Descent Parsers")

Title-case.

> +    (description
> +     "Parse::RecDescent can incrementally generate top-down recursive-descent

@code{Parse::RecDescent}.

> +    (license (package-license perl))))

license:perl-license

OK with these changes, thank you!

Ludo’.

[bug#28127] [PATCH 1/2] perl: Add perl-parse-recdescent.

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 730 bytes --]

On Wed, 04 Oct 2017 16:45:45 +0200
ludo@gnu.org (Ludovic Courtès) wrote:

> Christopher Baines <mail@cbaines.net> skribis:
> 
> > * gnu/packages/perl.scm (perl-parse-recdescent): New variable.  
> 
> [...]
> 
> > +    (home-page
> > +     "http://search.cpan.org/dist/Parse-RecDescent")
> > +    (synopsis "Generate Recursive-Descent Parsers")  
> 
> Title-case.
> 
> > +    (description
> > +     "Parse::RecDescent can incrementally generate top-down
> > recursive-descent  
> 
> @code{Parse::RecDescent}.
> 
> > +    (license (package-license perl))))  
> 
> license:perl-license
> 
> OK with these changes, thank you!

I've sent an updated patch with these changes now, thanks for
reviewing :)


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

[bug#28127] [PATCH 1/2] perl: Add perl-parse-recdescent.

[Christopher Baines]

* gnu/packages/perl.scm (perl-parse-recdescent): New variable.
---
 gnu/packages/perl.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/perl.scm b/gnu/packages/perl.scm
index 09d679817..815a212d1 100644
--- a/gnu/packages/perl.scm
+++ b/gnu/packages/perl.scm
@@ -8885,6 +8885,31 @@ YAML-style files, written with as little code as possible, reducing load time
 and memory overhead.")
     (license (package-license perl))))
 
+(define-public perl-parse-recdescent
+  (package
+    (name "perl-parse-recdescent")
+    (version "1.967015")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append
+             "mirror://cpan/authors/id/J/JT/JTBRAUN/Parse-RecDescent-"
+             version
+             ".tar.gz"))
+       (sha256
+        (base32
+         "0dvfcn2xvj9r4ra5xqgasl847nsm1iy85w1kly41fkxm9im36hqr"))))
+    (build-system perl-build-system)
+    (native-inputs
+     `(("perl-module-build" ,perl-module-build)))
+    (home-page
+     "http://search.cpan.org/dist/Parse-RecDescent")
+    (synopsis "Generate recursive-descent parsers")
+    (description
+     "@code{Parse::RecDescent} can incrementally generate top-down
+recursive-descent text parsers from simple yacc-like grammar specifications.")
+    (license perl-license)))
+
 (define-public perl-parse-yapp
   (package
     (name "perl-parse-yapp")
-- 
2.14.2

[bug#28127] [PATCH 2/2] web: Add nginx-documentation.

[Christopher Baines]

* gnu/packages/web.scm (nginx): Add comment about updating the documentation.
  (nginx-xslscript): New variable.
  (nginx-docs): New variable.
---
 gnu/packages/web.scm | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)

diff --git a/gnu/packages/web.scm b/gnu/packages/web.scm
index a2af98da5..a612be013 100644
--- a/gnu/packages/web.scm
+++ b/gnu/packages/web.scm
@@ -43,6 +43,7 @@
   #:use-module (guix download)
   #:use-module (guix git-download)
   #:use-module (guix cvs-download)
+  #:use-module (guix hg-download)
   #:use-module (guix utils)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system glib-or-gtk)
@@ -139,6 +140,8 @@ and its related documentation.")
 (define-public nginx
   (package
     (name "nginx")
+    ;; Consider updating the nginx-docs package if the nginx package is
+    ;; updated.
     (version "1.12.1")
     (source (origin
               (method url-fetch)
@@ -225,6 +228,101 @@ and as a proxy to reduce the load on back-end HTTP or mail servers.")
     ;;     except for two source files which are bsd-4 licensed.
     (license (list l:bsd-2 l:expat l:bsd-3 l:bsd-4))))
 
+(define nginx-xslscript
+  (let ((revision 11)
+        (changeset "01dc9ba12e1b"))
+    (package
+      (name "nginx-xslscript")
+      (version
+       (simple-format #f "2014-03-31-~A-~A" revision changeset))
+      (source (origin
+                (method hg-fetch)
+                (uri (hg-reference
+                      (url "http://hg.nginx.org/xslscript")
+                      (changeset changeset)))
+                (file-name (string-append name "-" version))
+                (sha256
+                 (base32
+                  "0am8zvdx3jmiwkg5q07qjaw5r26r4i2v5i4yr8a1k0jgib6ii08g"))))
+      (build-system gnu-build-system)
+      (arguments
+       '(#:tests? #f  ; No test suite
+         #:phases
+         (modify-phases %standard-phases
+           (delete 'configure)
+           (delete 'build)
+           (replace 'install
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((out-bin (string-append
+                               (assoc-ref outputs "out")
+                               "/bin")))
+                 (mkdir-p out-bin)
+                 (copy-file "xslscript.pl"
+                            (string-append
+                             out-bin
+                             "/xslscript.pl"))
+                 #t))))))
+      (home-page "http://hg.nginx.org/xslscript")
+      (synopsis "XSLScript with NGinx specific modifications")
+      (description
+       "XSLScript is a terse notation for writing complex XSLT stylesheets.
+This is modified version, specifically intended for use with the NGinx
+documentation.")
+      (license l:bsd-2))))
+
+(define-public nginx-documentation
+  ;; This documentation should be relevant for nginx-1.12.0
+  (let ((revision 1961)
+        (changeset "dd4b6c564e10"))
+    (package
+      (name "nginx-documentation")
+      (version
+       (simple-format #f "2017-04-12-~A-~A" revision changeset))
+      (source
+       (origin (method hg-fetch)
+               (uri (hg-reference
+                     (url "http://hg.nginx.org/nginx.org")
+                     (changeset changeset)))
+               (file-name (string-append name "-" version))
+               (sha256
+                (base32
+                 "0rycfnnm2xkm777769h1zib428q45j64mx8nzzfzs4v07jbfc8m5"))))
+      (build-system gnu-build-system)
+      (arguments
+       '(#:tests? #f  ; No test suite
+         #:phases
+         (modify-phases %standard-phases
+           (delete 'configure)
+           (replace 'build
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((output (assoc-ref outputs "out")))
+                 (substitute* "umasked.sh"
+                   ((" /bin/sh") (string-append " " (which "sh"))))
+                 ;; The documentation includes a banner, which makes sense on
+                 ;; the NGinx website, but doesn't make much sense when
+                 ;; viewing locally. Therefore, modify the CSS to remove the
+                 ;; banner.
+                 (substitute* "xslt/style.xslt"
+                   (("#banner           \\{ background:     black;")
+                    "#banner           { background:     black;
+                            display:     none;"))
+                 (zero? (system* "make")))))
+           (replace 'install
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let ((output (assoc-ref outputs "out")))
+                 (mkdir-p output)
+                 (copy-recursively "libxslt" output)
+                 #t))))))
+      (native-inputs
+       `(("libxml2" ,libxml2)
+         ("libxslt" ,libxslt)
+         ("nginx-xslscript" ,nginx-xslscript)))
+      (home-page "https://nginx.org")
+      (synopsis "Documentation for nginx web server")
+      (description
+       "This package provides HTML documentation for the nginx web server.")
+      (license l:bsd-2))))
+
 (define-public fcgi
   (package
     (name "fcgi")
-- 
2.14.2

[bug#28127] [PATCH 2/2] web: Add nginx-documentation.

[Ludovic Courtès]

Christopher Baines <mail@cbaines.net> skribis:

> * gnu/packages/web.scm (nginx): Add comment about updating the documentation.
>   (nginx-xslscript): New variable.
>   (nginx-docs): New variable.
             ^^
nginx-documentation

OK!

bug#28127: [PATCH 2/2] web: Add nginx-documentation.

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 429 bytes --]

On Sat, 07 Oct 2017 22:31:30 +0200
ludo@gnu.org (Ludovic Courtès) wrote:

> Christopher Baines <mail@cbaines.net> skribis:
> 
> > * gnu/packages/web.scm (nginx): Add comment about updating the
> > documentation. (nginx-xslscript): New variable.
> >   (nginx-docs): New variable.  
>              ^^
> nginx-documentation
> 
> OK!

I've fixed the commit message now, and pushed this. Thanks again for
reviewing :)

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

[bug#28127] [PATCH 1/2] perl: Add perl-parse-recdescent.

[Ludovic Courtès]

Christopher Baines <mail@cbaines.net> skribis:

> * gnu/packages/perl.scm (perl-parse-recdescent): New variable.

OK!