unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: "Noé Lopez via Guix-patches via" <guix-patches@gnu.org>
To: 74340@debbugs.gnu.org
Cc: Quanrong <quanrong@mailbox.org>
Subject: [bug#74340] Subject: [PATCH 1/1] gnu: Add stdman
Date: Thu, 14 Nov 2024 17:05:51 +0100	[thread overview]
Message-ID: <878qtlvm00.fsf@xn--no-cja.eu> (raw)
In-Reply-To: <022e3f60-916c-4f89-b0cf-8647cc67d67c@mailbox.org>

Hi,

Thank you for your patch, the package works well but there are a few
style errors:

> * gnu/packages/documentation.scm (stdman): New variable.
> 
> Change-Id: I4ed70b6ad4208bde4df13d45fd7241096f2469a1
> ---
>   gnu/packages/documentation.scm | 25 +++++++++++++++++++++++++
>   1 file changed, 25 insertions(+)
> 
> diff --git a/gnu/packages/documentation.scm b/gnu/packages/documentation.scm
> index f0e37561f7..928e022239 100644
> --- a/gnu/packages/documentation.scm
> +++ b/gnu/packages/documentation.scm
> @@ -14,6 +14,7 @@
>   ;;; Copyright © 2022 Maxim Cournoyer <maxim.counoyer@gmail.com>
>   ;;; Copyright © 2023 Janneke Nieuwenhuizen <janneke@gnu.org>
>   ;;; Copyright © 2024 Felix Gruber <felgru@posteo.net>
> +;;; Copyright © 2024 Tomás Ortín Fernández <quanrong@mailbox.org>
>   ;;;
>   ;;; This file is part of GNU Guix.
>   ;;;
> @@ -566,3 +567,27 @@ (define-public stddoc
>   supported programming languages.  Markdeep code comments are extracted 
> from stdin and
>   printed into stdout as a HTML file.")
>         (license license:unlicense))))
> +
> +(define-public stdman
> +  (let ((commit "b7070fe10143411a8d69fe3a9f75e90008a8386d")
> +	(revision "0")) ;; Last release is outdated
> +    (package
> +      (name "stdman")
> +      (version (git-version "20240610" revision commit))
> +      (source (origin
> +		(method git-fetch)
> +		(uri (git-reference
> +		      (commit commit)
> +		      (url "https://github.com/jeaye/stdman")))
> +		(sha256
> +		 (base32 "0h1gfw4sxic5gx073zmshg4qyz2g142ckgzyj30pk8j708mnl8pz"))))
> +      (build-system gnu-build-system)
> +      (arguments
> +       (list
> +	#:tests? #f ;; There are no tests

There should be a dot at the end of comments, and only one semicolon if
it’s a margin comment.

> +	#:phases #~(modify-phases %standard-phases
> +		     (delete 'build))))
> +      (description "Formatted C++ @code{stdlib} man pages from 
> cppreference")
> +      (synopsis "stdman is a tool that provides C++ @code{stdlib} 
> documentation archived from cppreference as groff-formated man pages, 
> accessible from the @code{man} command.")

Description and synopsis are swapped (synopsis should be the small one).

> +      (home-page "https://github.com/jeaye/stdman")
> +      (license license:expat))))
> 
> base-commit: 1f057603ef59c7b9c32f610a897321fd75dc4dad
> -- 
> 2.46.0

I’m sending an updated patch with these small modifications.

Have a good day,
Noé




  reply	other threads:[~2024-11-14 16:12 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-13 12:01 [bug#74340] Subject: [PATCH 1/1] gnu: Add stdman Quanrong via Guix-patches via
2024-11-14 16:05 ` Noé Lopez via Guix-patches via [this message]
2024-11-14 16:08 ` [bug#74340] [PATCH v2] " Noé Lopez via Guix-patches via

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=878qtlvm00.fsf@xn--no-cja.eu \
    --to=guix-patches@gnu.org \
    --cc=74340@debbugs.gnu.org \
    --cc=noe@xn--no-cja.eu \
    --cc=quanrong@mailbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).