unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Giovanni Biscuolo <g@xelera.eu>
To: guix-devel@gnu.org
Subject: packaging - sentences in description
Date: Mon, 18 Mar 2019 15:34:18 +0100	[thread overview]
Message-ID: <87k1gwtfo5.fsf@roquette.mug.biscuolo.net> (raw)

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

Hi Guix

I'm packaging go-github-com-burntsushi-locker, this is the package
definition:

--8<---------------cut here---------------start------------->8---
(define-public go-github-com-burntsushi-locker
  (let ((commit "a6e239ea1c69bff1cfdb20c4b73dadf52f784b6a")
        (revision "0"))
    (package
      (name "go-github-com-burntsushi-locker")
      (version (git-version "0.0.0" revision commit))
      (source
       (origin
         (method git-fetch)
         (uri (git-reference
               (url "https://github.com/BurntSushi/locker")
               (commit commit)))
         (file-name (git-file-name name version))
         (sha256
          (base32
           "1xak4aync4klswq5217qvw191asgla51jr42y94vp109lirm5dzg"))))
      (build-system go-build-system)
      (arguments
       '(#:import-path "github.com/BurntSushi/locker"))
      (home-page "https://github.com/BurntSushi/locker")
      (synopsis "Manage named ReadWrite mutexes in Go")
      (description "Golang package for conveniently using named read/write
locks. These appear to be especially useful for synchronizing access to
session based information in web applications. 
  
The common use case is to use the package level functions, which use a package
level set of locks (safe to use from multiple goroutines
simultaneously). However, you may also create a new separate set of locks
test. 
  
All locks are implemented with read-write mutexes. To use them like a regular
mutex, simply ignore the RLock/RUnlock functions.")
      (license license:public-domain))))
--8<---------------cut here---------------end--------------->8---

it builds but when I check its description I get [1]:

--8<---------------cut here---------------start------------->8---
giovanni@anemone: time ./pre-inst-env guix lint -c description go-github-com-burntsushi-locker
gnu/packages/golang.scm:3202:19: go-github-com-burntsushi-locker@0.0.0-0.a6e239e: sentences in description should be followed by two spaces; possible infractions at 60, 329, 447

Some deprecated features have been used.  Set the environment
variable GUILE_WARN_DEPRECATED to "detailed" and rerun the
program to get more information.  Set it to "no" to suppress
this message.

real	4m24.644s
user	5m24.480s
sys	0m1.420s
--8<---------------cut here---------------end--------------->8---

I copy/pasted and adapted the description from the project homepage,
I'm using emacs and auto-fill mode on so it should have followed the
rules in .dir-locals.el 

I can't understand where the sentences in my description lacks the two
required spaces: any hint please?

Thanks!
Gio

[1] it takes more than five minutes just for the description: I will
diligently do it for all my packages :-)... but it's a little bit
discouraging :-S

[2] https://www.gnu.org/software/guix/manual/en/html_node/Synopses-and-Descriptions.html#Synopses-and-Descriptions

-- 
Giovanni Biscuolo

Xelera IT Infrastructures

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

             reply	other threads:[~2019-03-18 14:34 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-18 14:34 Giovanni Biscuolo [this message]
2019-03-18 14:42 ` packaging - sentences in description Julien Lepiller
2019-03-18 14:54 ` Tobias Geerinckx-Rice
2019-03-18 16:14   ` Giovanni Biscuolo

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=87k1gwtfo5.fsf@roquette.mug.biscuolo.net \
    --to=g@xelera.eu \
    --cc=guix-devel@gnu.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).