Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <4b0030d99fd6698fd8d5a4e17b0df658a02e6788.camel@gmail.com>
Subject: Re: [BlueZ v2] monitor: Update manpage
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>
Date:   Fri, 30 Apr 2021 20:22:30 -0700
In-Reply-To: <BA960BC0-D602-4B59-BFF4-6ADF1B487081@holtmann.org>
References: <20210428062214.335567-1-hj.tedd.an@gmail.com>
         <CABBYNZJJHLZdhOFHrTHV7XN7++t4XKq3yHxS2wsi2bJ2AkRnVw@mail.gmail.com>
         <87c5b74558d3062f301dbfa28b93cdbfbe310dd2.camel@gmail.com>
         <CABBYNZKYDBQFqf8uVeXZNg-OVBks96fqRMk+8S+029Y26dSiow@mail.gmail.com>
         <BA960BC0-D602-4B59-BFF4-6ADF1B487081@holtmann.org>
Content-Type: text/plain; charset="UTF-8"
User-Agent: Evolution 3.36.5 (3.36.5-2.fc32) 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Precedence: bulk

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