Code review comment for lp:~stefanor/ibid/manpages-510020

Revision history for this message
marcog (marco-gallotta) wrote :

Most comments here are pedantic, so ignore them if you feel like it. :)

> There should there be an existing ibid.ini in the current directory, or one should be
> provided on the command line.

Can ibid.ini not be located in /etc ?

> Note that you should use twistd(1) where possible instead of calling this directly,
> as certain classes of error (problems in twisted callbacks) will go unnoticed in this
> program. That has no harmful effects, but the developers may miss out on some good
> bug reports.

Should this really be under "BUGS"?

How about adding that this can be achieved by running "twistd -n ibid"?

> SEE ALSO
> ibid(1), ibid.ini(5), ibid-setup(1), http://ibid.omnia.za.net/

This is in ibid.1. Should it really be referencing what I believe is itself?

> A complete description of the contents of this file is out of the scope of this man‐
> page, for more details see the Ibid documentation.

Break up into 2 sentences.

> This file will be written to by the bot when configuration settings are altered
> online. It can also be edited manually and a running bot told to "reload config".

Maybe mention that when automatically written to, the bot will preserve manual edits.

Weren't there some bugs associated with "reload config" not fully working? Perhaps mention them under a BUGS section.

> Settings related to permissions and authentication. Permissions listed in auth.per‐
> missions are granted to all users unless revoked by source or account.

I don't like how tha man page splits auth.permissions over multiple lines. Is there a way to force it to keep it on a single line?

> Plugin configuration, each plugin is configured within a section named after the plu‐
> gin.

I don't like that comma. Maybe a colon? There are also other places where this occurs.

> SEE ALSO
> ibid(1), ibid-objgraph(1), http://ibid.omnia.za.net/

This is in ibid-objgraph.1. I guess that ibid-objgraph(1) should have been ibid-memgraph(1)

> This utility is passing events to a running Ibid bot, or executing RPC-exposed func‐
> tions remotely.

This utility is *for* passing

> ibid-plugin.1 BUGS

It also doesn't emulate accounts/identities.

> ibid-setup - Create a configuration file and Database for an Ibid bot

Create a *basic* configuration file and *d*atabase as a starting point for an Ibid bot

> This program installs a new Ibid bot.

Does it really *install* the bot? When I read install, I think it does more than what this script does. Maybe "configures"?

review: Needs Fixing

« Back to merge proposal