From: ludo@gnu.org (Ludovic Courtès)
To: Danny Milosavljevic <dannym@scratchpost.org>
Cc: guix-devel@gnu.org
Subject: Re: [PATCH v2] gnu: Add sunxi-tools.
Date: Tue, 04 Oct 2016 15:15:39 +0200 [thread overview]
Message-ID: <87vax88dc4.fsf@gnu.org> (raw)
In-Reply-To: <20161004120738.2351b604@scratchpost.org> (Danny Milosavljevic's message of "Tue, 4 Oct 2016 12:07:38 +0200")
Danny Milosavljevic <dannym@scratchpost.org> skribis:
>> I don’t understand this description. Since “Tools”, “manage”, and
>> “devices” could mean anything, could you add qualifiers to give more
>> context, like:
>>
>> “Frobbing tools for Allwinner A10 foobar devices”
>>
>> and similarly expound the description (with a period at the end of the
>> sentence)?
>>
>> Based on that, we might device that admin.scm is not the best fit for
>> this package. Maybe flashing-tools.scm?
>
> The tools included are:
I’m not asking that you explain it to me personally ;-), but rather that
the description conveys a message that makes sense both for the domain
expert and the passerby.
https://www.gnu.org/software/guix/manual/html_node/Synopses-and-Descriptions.html
> So how about this description:
>
> (description "This package contains tools for Allwinner A10 devices:
> - sunxi-fexc, bin2fex, fex2bin: Compile a textual description of a board (.fex) to a binary representation (.bin).
> - sunxi-fel: Puts a Allwinner A10 device into FEL mode which makes it register as a special USB device (rather than USB host). You can then connect it to another computer and flash it from there.
> - sunxi-nand-part: Partitions NAND flash.
> - sunxi-bootinfo: Reads out boot0 and boot1 information. These are the bootloaders before U-Boot.
> - sunxi-pio: Sets GPIO and oscillates a GPIO in order to be able to find it.
> ")
Sure. Make sure to use @enumerate/@item for the list, and @command for
the command names.
This still doesn’t address the synopsis issue as I wrote above. What
about this synopsis:
Hardware management tools for Allwinner A10 single-board computers
?
Please send a patch the addresses this and I’ll happily apply it!
Ludo’.
next prev parent reply other threads:[~2016-10-04 13:15 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-29 11:02 [PATCH] gnu: Add sunxi-tools Danny Milosavljevic
2016-10-02 1:54 ` Leo Famulari
2016-10-02 9:54 ` Danny Milosavljevic
2016-10-02 9:57 ` Vincent Legoll
2016-10-02 10:01 ` Danny Milosavljevic
2016-10-02 9:58 ` [PATCH v2] " Danny Milosavljevic
2016-10-04 9:19 ` Ludovic Courtès
2016-10-04 10:07 ` Danny Milosavljevic
2016-10-04 13:15 ` Ludovic Courtès [this message]
2016-10-04 14:38 ` Vincent Legoll
2016-10-05 3:03 ` [PATCH v3] " Danny Milosavljevic
2016-10-05 16:51 ` Ludovic Courtès
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=87vax88dc4.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=dannym@scratchpost.org \
--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).