Re: [Dragora-members] Qi 2.0rc9

[Matias Fonzo]

El 2020-06-24 11:10, Michael Siegel escribió:
> Am 23.06.20 um 01:11 schrieb Matias Fonzo:
> > Attached is Qi 2.0 Release Candidate 9.
> >
> > Note that the examples provided are a little outdated, otherwise
> > comments or suggestions are welcome.  :-)
>
> Thanks for sending this out!
>
> Here are a few comments from my side:
>
>
> #1
>
> I still think that -V should be the short option for --version, and not
> mean "very verbose". Instead, verbosity should be increased simply by
> specifying the same option several times, i.e.:
>
>   -v
>     verbose
>   -v -v, or simply: -vv
>     more verbose
>
> I find this much more logical because "more verbosity" means "more of
> the same thing", and that is exactly what -vv is, while -V rather
> represents "a slightly different version of the same thing".
>
> I also think that using -vv would actually make the code easier to
> follow because there would be only one option dealing with verbosity,
> and not two.

I will see what can I do, this will require to add a bit of more code 
into Qi.

> #2
>
> I would rather not call Qi's commands (install, remove, upgrade etc.)
> "operating modes". This seems really confusing and unintuitive. I mean,
> you tell Qi to do a certain thing, like install a package, right? I
> would call that "giving commands to Qi". Or, put in another way,
> something like
>
>   qi install <package>
>
> is really like telling Qi "Do this!", in this case: install a package.
>
> The word "operation mode" really doesn't fit that well, if you ask me.
>
> Instead, running a Qi command with the -f option could well be called
> running that command "in force mode". We don't do that, of course,
> because it's not necessary. I'm just trying to say that the term
> "operation mode" is actually something that fits using options on a
> certain command much more than using the command itself.
>
> For example, if you were telling someone: Install it, but do it gently.
> "Install" would be the action, or the command, "gentle" would be the
> desired "mode of operation".
>
> Okay, I'm starting to repeat myself. You get the idea.

Good, I renamed "mode/modes" to "command/commands" except in the code, 
where 'command' is a reserved builtin of the shell.

> #3
>
> Description of Qi commands in the manual page:
>
> Some of the descriptions need to have a line break added before them.
>
> Then, the description of "extract" says:
>
>   Extract package for debugging purposes
>
> Does this strictly mean "a single package"? If it does, I'd say "a
> package" there, otherwise "packages".
>
> The same goes for the description of the "create" command.

It was plural, recently changed on my local repo.  :-)

> #4
>
> Options when building software packages using recipes
>  -a, --architecture
>               Set architecture name for the package [x86_64]
>
> If you're gonna go with "amd64" instead of "x86_64", you'll have to
> change the architecture name given in brackets.

That's a local, set up for Dragora (the distribution).  Otherwise the 
default value in Qi is obtained via `uname -m'.

> #5
>
> Lastly, there is still a bit of a problem with the structure of that
> manual page. DESCRIPTION shouldn't contain everything it contains at 
> the
> moment. For example, the options overview should really be in a 
> separate
> OPTIONS section. Environment variables should also have a section of
> their own, called ENVIRONMENT. Also, adding an AUTHORS section (even if
> there's only one author) seems like a good idea. man(1) has more
> information on those things.

Yes, that's because the manual page is currently generated using 
`help2man'...

I'll see if I can write a page manually, if we don't change anything 
else in Qi.

> Now, after that round of knocking Qi, let me say that I think this all
> looks pretty good already, in general, and I'm really looking forward 
> to
> the beta2 release.

Thank you!  ;-)