Re: lacie-uboot : Please review the description
On Mon, Nov 19, 2012 at 10:18 PM, Justin B Rye <jbr@edlug.org.uk> wrote:
> Maxime Hadjinlian wrote:
>>>> Description : lacie u-boot netconsole shell
>>>
>>> Well, for a start it needs to be "LaCie U-Boot".
>> Alright, my bad, I though capital letter were not authorized.
>
> The rule is just that short descriptions don't get any *extra*
> capital letters (compare the way a sentence gets the first word
> capitalised and a book title gets most words capitalised).
Ok
>
> [...]
>>> What does the description of capsup mean by "update your system"? Why
>>> would you need to "update your bootloader"? Again, I have no idea
>>> what problem this software is designed to solve. And why is it called
>>> capsup?
>> It is called capsup because LaCie gives its update as "capsule" so
>> it's a contraction of capsule and update.
>> I realize while typing it that as you said, it needs a lot of
>> knowledge from the user to understand what it could do.
>
> Oh, so it's a sort of TFTP microcode flashing tool?
Sort of, it's not really "micro" because for a NAS, the firmware is a
"small" linux distribution.
But yes, it's the main purposes, flashing the bootloader or the linux
distro on your NAS.
And since the "capsule" format is known publicly, you could package
your very own firmware and use this to install whatever you want on
your NAS.
But the most interesting part is really plum as it let you interact
with the U-Boot netconsole without any extra materials (an rs232 cable
would be needed to access it without plum), it's really usefull if you
want to boot your product from a USB stick for example.
>
> [...]
>> Thank you very much for all your advices and input.
>> I will rename the tools and write a proper help/manual/description
>> from your advices, then I'll send another email for reviewing.
>>
>> I was thinking about lacie-uboot-shell for the package name and :
>> - plum could be lacie-uboot-shell
>> - capsup could be lacie-nas-updater
>>
>> I don't know if it's preferred to use short name and contraction or
>> longer but clearer names ? I would love some pointers so I could try
>> and think about new names.
>
> It depends whether this is something I'm going to be running as often
> as "ls" or something I'm going to be running as often as "sudo
> /usr/sbin/unregister-common-lisp-implementation".
>
Yeah, it's surely something that would not be typed that often.
> As it happens "lac" makes a fairly good prefix for tab-completion,
> since the only competition is from lacheck. If the company name was
> "gnomex" or something it would require a bit more actual typing.
:)
Here is my try at the long description (I did not change the name in
the code yet, I'd like to wait for a settlement here first)
Description: LaCie U-Boot netconsole shell
LaCie newgen network storage products offer a U-Boot netconsole.
This package provides a collection of tools to access this netconsole:
* lacie-uboot-shell - a simple way to connect and interact with
U-Boot netconsole using only a network cable.
* lacie-nas-updater - a script to update your product
bootloader or firmware
using lacie-uboot-shell.
Requires a TFTP server.
> --
> JBR with qualifications in linguistics, experience as a Debian
> sysadmin, and probably no clue about this particular package
Reply to: