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: <af74d77e80e6cba4f46658aa794de9d3b5853abf.camel@gmail.com>
Subject: Re: [PATCH BlueZ] mesh: Add manpage for bluetooth-meshd daemon
From:   Tedd Ho-Jeong An <hj.tedd.an@gmail.com>
To:     Inga Stotland <inga.stotland@intel.com>,
        linux-bluetooth@vger.kernel.org
Date:   Mon, 17 May 2021 10:37:21 -0700
In-Reply-To: <20210517052357.360724-1-inga.stotland@intel.com>
References: <20210517052357.360724-1-inga.stotland@intel.com>
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 Inga,

On Sun, 2021-05-16 at 22:23 -0700, Inga Stotland wrote:
> This adds manpage with a brief description of BLuettoth Mesh daemon
> command line options.
> ---
>  Makefile.mesh               |  5 +++
>  configure.ac                |  3 +-
>  mesh/bluetooth-meshd.rst.in | 74 +++++++++++++++++++++++++++++++++++++
>  4 files changed, 83 insertions(+), 1 deletion(-)
>  create mode 100644 mesh/bluetooth-meshd.rst.in
> 
> diff --git a/.gitignore b/.gitignore
> index 9c8393a81..9f57aa193 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -145,6 +145,8 @@ tools/meshctl
>  tools/mesh-cfgclient
>  tools/mesh-cfgtest
>  mesh/bluetooth-meshd
> +mesh/bluetooth-meshd.8
> +mesh/bluetooth-meshd.rst
>  
>  src/bluetoothd.8
>  src/bluetoothd.rst
> diff --git a/Makefile.mesh b/Makefile.mesh
> index 73eaded4a..fc28b0557 100644
> --- a/Makefile.mesh
> +++ b/Makefile.mesh
> @@ -47,6 +47,11 @@ mesh_bluetooth_meshd_LDADD = src/libshared-ell.la $(ell_ldadd) -ljson-c
>  mesh_bluetooth_meshd_DEPENDENCIES = $(ell_dependencies) src/libshared-ell.la \
>  				mesh/bluetooth-mesh.service
>  
> +if MANPAGES
> +man_MANS += mesh/bluetooth-meshd.8
> +endif
> +manual_pages += mesh/bluetooth-meshd.8
> +
>  CLEANFILES += mesh/bluetooth-mesh.service
>  
>  endif
> diff --git a/configure.ac b/configure.ac
> index 5157da1b5..af700eb13 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -392,6 +392,7 @@ AC_SUBST(CONFIGDIR, "${configdir}")
>  
>  AC_DEFINE_UNQUOTED(MESH_STORAGEDIR, "${storagedir}/mesh",
>  			[Directory for the mesh daemon storage files])
> +AC_SUBST(MESH_STORAGEDIR, "${storagedir}/mesh")
>  
>  AC_ARG_ENABLE(android, AC_HELP_STRING([--enable-android],
>  			[enable BlueZ for Android]),
> @@ -415,4 +416,4 @@ fi
>  AC_DEFINE_UNQUOTED(ANDROID_STORAGEDIR, "${storagedir}/android",
>  			[Directory for the Android daemon storage files])
>  
> -AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc)
> +AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc mesh/bluetooth-meshd.rst)
> diff --git a/mesh/bluetooth-meshd.rst.in b/mesh/bluetooth-meshd.rst.in
> new file mode 100644
> index 000000000..06cdb69da
> --- /dev/null
> +++ b/mesh/bluetooth-meshd.rst.in
> @@ -0,0 +1,74 @@
> +===============
> +bluetooth-meshd
> +===============
> +
> +---------------------
> +Bluetooth Mesh daemon
> +---------------------
> +
> +:Version: BlueZ
> +:Copyright: Free use of this software is granted under ther terms of the GNU
> +            Lesser General Public Licenses (LGPL).
> +:Date: March 2021
> +:Manual section: 8
> +:Manual group: Linux Connectivity
> +
> +SYNOPSIS
> +========
> +
> +**bluetooth-meshd** [*options* ...]
> +
> +DESCRIPTION
> +===========
> +
> +Daemon for managing Bluetooth Mesh connections on Linux.
> +
> +OPTIONS
> +=======
> +
> +-h, --help
> +    Print bluetooth-meshd options and exit.
> +
> +-n, --nodetach
> +    Enable logging in foreground. Directs log output to the controlling
> +    terminal in addition to syslog.
> +
> +-i <type>, --io <type>
> +    Specifies I/O interface type:
> +
> +    *hci<index>* - Use generic HCI io on interface hci<index>,
> +    or, if no idex is specified, the first available one.
> +
> +    *unit:<fd_path>*- Specifies open file descriptor for
> +    daemon testing.
> +
> +    By default, if no type is specified, uses generic I/O
> +    on the first available HCI interface.
> +
> +-c <file>, --config <file>
> +    Specifies an explicit config file path instead of relying on the
> +    default path(*@CONFIGDIR@/mesh-main.conf*) for the config file.
> +
> +-s <dir_path>, --storage <dir path>
> +    Specifies an explicit storage directory path instead of the default
> +    path(*@MESH_STORAGEDIR@*) for storing mesh node(s) configuration.
> +
> +-d, --debug         Enable debug output.
> +
> +-b, --dbus-debug    Enable D-Bus debug output.
> +
> +FILES
> +=====
> +
> +*@CONFIGDIR@/mesh-main.conf*
> +    Location of the global configuration file containing mesh daemon settings.
> +
> +RESOURCES
> +=========
> +
> +http://www.bluez.org
> +
> +REPORTING BUGS
> +==============
> +
> +linux-bluetooth@vger.kernel.org

The patch looks good to me.
However, the CI didn't run because of the other internal issue, and I am looking into it.

Regards,
Tedd