All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tedd Ho-Jeong An <hj.tedd.an@gmail.com>
To: Marcel Holtmann <marcel@holtmann.org>,
	Luiz Augusto von Dentz <luiz.dentz@gmail.com>
Cc: "linux-bluetooth@vger.kernel.org" <linux-bluetooth@vger.kernel.org>
Subject: Re: [BlueZ v2] monitor: Update manpage
Date: Fri, 30 Apr 2021 20:22:30 -0700	[thread overview]
Message-ID: <4b0030d99fd6698fd8d5a4e17b0df658a02e6788.camel@gmail.com> (raw)
In-Reply-To: <BA960BC0-D602-4B59-BFF4-6ADF1B487081@holtmann.org>

Hi Marcel,

On Sat, 2021-05-01 at 03:59 +0200, Marcel Holtmann wrote:
> Hi Luiz,
> 
> > > > > From: Tedd Ho-Jeong An <tedd.an@intel.com>
> > > > > 
> > > > > This patch updates the manpage for btmon written in rst format.
> > > > > ---
> > > > > Makefile.am       |  26 ++++---
> > > > > Makefile.tools    |   4 ++
> > > > > configure.ac      |   4 ++
> > > > > doc/btmon.txt     |  35 ----------
> > > > > monitor/btmon.rst | 172 ++++++++++++++++++++++++++++++++++++++++++++++
> > > > 
> > > > I do wonder why you change the location from doc to monitor, I think
> > > > we actually should keep all the documentation under doc and perhaps
> > > > even have a dedicated make target for those since we would likely want
> > > > to generate all the manpages from rst which may be time consuming so
> > > > people not interested on it can just skip it.
> > > 
> > > I converted all manpages in the tree to .rst and ready to submit.
> > > Can I combine all in this series or wait for this to merge first?
> > 
> > Have you added a make target for those? I really don't mind having the
> > manpages generated within the same location of the binary, although I
> > think it would be more organized to have it in one place, but a make
> > target would probably be a good practice.
> 
> the way how this works is that in a git tree they are always generated unless disabled or rst2man is not available. And in a tarball, the generated manual pages are shipped, which means they are not
> needed to be generated. So no specific make target required. Lets just copy what iwd repository doing since that is working fine.
> 
To align with iwd way, I suggest to make some changes in Makefile as well.
For example, disabling manpages are not working because the manpages are
added to dist_man_MANS without checking MANPAGES flags.

I converted all existing manpages to .rst format and ready to submit.
I will add them in this patch set.

> Regards
> 
> Marcel
> 

Regards,

Tedd


      reply	other threads:[~2021-05-01  3:22 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-28  6:22 [BlueZ v2] monitor: Update manpage Tedd Ho-Jeong An
2021-04-28  6:48 ` [BlueZ,v2] " bluez.test.bot
2021-04-30  3:51 ` [BlueZ v2] " Luiz Augusto von Dentz
2021-04-30  7:30   ` Marcel Holtmann
2021-04-30 21:43   ` Tedd Ho-Jeong An
2021-04-30 22:41     ` Luiz Augusto von Dentz
2021-05-01  1:59       ` Marcel Holtmann
2021-05-01  3:22         ` Tedd Ho-Jeong An [this message]

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4b0030d99fd6698fd8d5a4e17b0df658a02e6788.camel@gmail.com \
    --to=hj.tedd.an@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=luiz.dentz@gmail.com \
    --cc=marcel@holtmann.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.