From mboxrd@z Thu Jan 1 00:00:00 1970 Content-Type: multipart/mixed; boundary="===============8072669268810200426==" MIME-Version: 1.0 From: Marcel Holtmann Subject: Re: [RFC patches 10/13] doc: explain debugging options to -d, add a pointer in -h to manpage Date: Tue, 08 Jun 2010 16:13:24 -0700 Message-ID: <1276038804.2182.55.camel@localhost.localdomain> In-Reply-To: <1276035129.2478.47.camel@localhost.localdomain> List-Id: To: ofono@ofono.org --===============8072669268810200426== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Hi Inaky, > > > From: Inaky Perez-Gonzalez > > > = > > > Modified HACKING and man page to have more formation on what are the > > > debugging options and how to enable them. > > > --- > > > HACKING | 10 ++++++++++ > > > doc/ofonod.8 | 5 ++++- > > > src/main.c | 4 +++- > > > 3 files changed, 17 insertions(+), 2 deletions(-) > > > = > > > diff --git a/HACKING b/HACKING > > > index ae420aa..e825185 100644 > > > --- a/HACKING > > > +++ b/HACKING > > > @@ -81,3 +81,13 @@ automatically includes this option. > > > = > > > For production installations or distribution packaging it is importa= nt that > > > the "--enable-maintainer-mode" option is NOT used. > > > + > > > +Note multiple arguments to -d can be specified, colon, comma or space > > > +separated. The arguments are relative source code filenames for which > > > +debugging output should be enabled; output shell-style globs are > > > +accepted (e.g.: 'plugins/*:src/main.c'). > > > + > > > +Other debugging settings that can be toggled: > > > + > > > + - Environment variable OFONO_AT_DEBUG (set to 1): enable AT commands > > > + debugging > > > diff --git a/doc/ofonod.8 b/doc/ofonod.8 > > > index 474d7fb..7bb908c 100644 > > > --- a/doc/ofonod.8 > > > +++ b/doc/ofonod.8 > > > @@ -18,7 +18,10 @@ is used to manage \fID-Bus\fP permissions for oFon= o. > > > .SH OPTIONS > > > .TP > > > .B --debug, -d > > > -Enable debug information output. > > > +Enable debug information output. Note multiple arguments to -d can be > > > +specified, colon, comma or space separated. The arguments are relati= ve > > > +source code filenames for which debugging output should be enabled; > > > +output shell-style globs are accepted (e.g.: "plugins/*:src/main.c"). > > > .TP > > > .B --nodetach, -n > > > Don't run as daemon in background. > > = > > you need to hook this up to automake :) > = > Can you clarify, please? we do wanna install the man pages, right? Then this needs man_MANS and EXTRA_DIST magic to get included and installed. > > > diff --git a/src/main.c b/src/main.c > > > index 8e686ac..c5791be 100644 > > > --- a/src/main.c > > > +++ b/src/main.c > > > @@ -98,7 +98,9 @@ static gboolean option_version =3D FALSE; > > > = > > > static GOptionEntry options[] =3D { > > > { "debug", 'd', 0, G_OPTION_ARG_STRING, &option_debug, > > > - "Specify debug options to enable", "DEBUG" }, > > > + "Specify debug options to enable (see the " > > > + "man page for ofonod(8) for more information).", > > > + "DEBUG" }, > > > { "nodetach", 'n', G_OPTION_FLAG_REVERSE, > > > G_OPTION_ARG_NONE, &option_detach, > > > "Don't run as daemon in background" }, > > = > > Please leave this out. If we have a man page and man ofonod works, then > > this is not needed. > = > Denis and me, AFAIR, agreed on this wording as it just gives the quick > pointer to where the extra information is found. Again, not critical, > but confusing feedback. Maybe I am too old school Linux here ;) If we have an installed man page and I don't understand the usage information, then it is clear to just do man ofonod. I don't need the usage tell me that. Regards Marcel --===============8072669268810200426==--