mbox series

[BlueZ,v3,0/4] Convert manpages to rst format

Message ID 20210504050207.841261-1-hj.tedd.an@gmail.com (mailing list archive)
Headers show
Series Convert manpages to rst format | expand

Message

Tedd Ho-Jeong An May 4, 2021, 5:02 a.m. UTC 
From: Tedd Ho-Jeong An <tedd.an@intel.com>

This patch set converts the existing troff fomatted manpages into
reStructuredText format, which is easier to write and manage.

Also, it fixes the issue which the manpages are alwasy installed by
default regardless of "enable-manpages" option is not set during
configuration.

In order to convert .rst to manpages(.1/.8), it requires rst2man tool
and now this tool is checked during configuration if the manpages is
enabled.

The contents of the manpages were not changed or updated while
converting the old manpages into .rst format.

Tedd Ho-Jeong An (4):
  build: Fix manpage enable flag
  monitor: Convert manpage to rst format
  src: Convert manpage to rst format
  tools: Convert manpages to rst format

 Makefile.am           |  37 +++---
 Makefile.tools        |  33 +++--
 configure.ac          |   6 +-
 doc/btmon.txt         |  35 ------
 monitor/btmon.rst     | 171 ++++++++++++++++++++++++++
 src/bluetoothd.8.in   |  63 ----------
 src/bluetoothd.rst.in |  84 +++++++++++++
 tools/bdaddr.1        |  68 -----------
 tools/bdaddr.rst      |  76 ++++++++++++
 tools/btattach.1      |  53 --------
 tools/btattach.rst    |  79 ++++++++++++
 tools/ciptool.1       |  68 -----------
 tools/ciptool.rst     |  71 +++++++++++
 tools/hciattach.1     | 158 ------------------------
 tools/hciattach.rst   | 166 ++++++++++++++++++++++++++
 tools/hciconfig.1     | 272 ------------------------------------------
 tools/hciconfig.rst   | 271 +++++++++++++++++++++++++++++++++++++++++
 tools/hcidump.1       | 118 ------------------
 tools/hcidump.rst     | 119 ++++++++++++++++++
 tools/hcitool.1       | 255 ---------------------------------------
 tools/hcitool.rst     | 213 +++++++++++++++++++++++++++++++++
 tools/hid2hci.1       |  46 -------
 tools/hid2hci.rst     |  50 ++++++++
 tools/l2ping.1        |  76 ------------
 tools/l2ping.rst      |  69 +++++++++++
 tools/rctest.1        |  90 --------------
 tools/rctest.rst      |  81 +++++++++++++
 tools/rfcomm.1        | 113 ------------------
 tools/rfcomm.rst      | 100 ++++++++++++++++
 tools/sdptool.1       | 132 --------------------
 tools/sdptool.rst     | 103 ++++++++++++++++
 31 files changed, 1701 insertions(+), 1575 deletions(-)
 delete mode 100644 doc/btmon.txt
 create mode 100644 monitor/btmon.rst
 delete mode 100644 src/bluetoothd.8.in
 create mode 100644 src/bluetoothd.rst.in
 delete mode 100644 tools/bdaddr.1
 create mode 100644 tools/bdaddr.rst
 delete mode 100644 tools/btattach.1
 create mode 100644 tools/btattach.rst
 delete mode 100644 tools/ciptool.1
 create mode 100644 tools/ciptool.rst
 delete mode 100644 tools/hciattach.1
 create mode 100644 tools/hciattach.rst
 delete mode 100644 tools/hciconfig.1
 create mode 100644 tools/hciconfig.rst
 delete mode 100644 tools/hcidump.1
 create mode 100644 tools/hcidump.rst
 delete mode 100644 tools/hcitool.1
 create mode 100644 tools/hcitool.rst
 delete mode 100644 tools/hid2hci.1
 create mode 100644 tools/hid2hci.rst
 delete mode 100644 tools/l2ping.1
 create mode 100644 tools/l2ping.rst
 delete mode 100644 tools/rctest.1
 create mode 100644 tools/rctest.rst
 delete mode 100644 tools/rfcomm.1
 create mode 100644 tools/rfcomm.rst
 delete mode 100644 tools/sdptool.1
 create mode 100644 tools/sdptool.rst

Comments

Luiz Augusto von Dentz May 4, 2021, 11:51 p.m. UTC | #1 
Hi Tedd,

On Mon, May 3, 2021 at 10:09 PM Tedd Ho-Jeong An <hj.tedd.an@gmail.com> wrote:
>
> From: Tedd Ho-Jeong An <tedd.an@intel.com>
>
> This patch set converts the existing troff fomatted manpages into
> reStructuredText format, which is easier to write and manage.
>
> Also, it fixes the issue which the manpages are alwasy installed by
> default regardless of "enable-manpages" option is not set during
> configuration.
>
> In order to convert .rst to manpages(.1/.8), it requires rst2man tool
> and now this tool is checked during configuration if the manpages is
> enabled.
>
> The contents of the manpages were not changed or updated while
> converting the old manpages into .rst format.
>
> Tedd Ho-Jeong An (4):
>   build: Fix manpage enable flag
>   monitor: Convert manpage to rst format
>   src: Convert manpage to rst format
>   tools: Convert manpages to rst format
>
>  Makefile.am           |  37 +++---
>  Makefile.tools        |  33 +++--
>  configure.ac          |   6 +-
>  doc/btmon.txt         |  35 ------
>  monitor/btmon.rst     | 171 ++++++++++++++++++++++++++
>  src/bluetoothd.8.in   |  63 ----------
>  src/bluetoothd.rst.in |  84 +++++++++++++
>  tools/bdaddr.1        |  68 -----------
>  tools/bdaddr.rst      |  76 ++++++++++++
>  tools/btattach.1      |  53 --------
>  tools/btattach.rst    |  79 ++++++++++++
>  tools/ciptool.1       |  68 -----------
>  tools/ciptool.rst     |  71 +++++++++++
>  tools/hciattach.1     | 158 ------------------------
>  tools/hciattach.rst   | 166 ++++++++++++++++++++++++++
>  tools/hciconfig.1     | 272 ------------------------------------------
>  tools/hciconfig.rst   | 271 +++++++++++++++++++++++++++++++++++++++++
>  tools/hcidump.1       | 118 ------------------
>  tools/hcidump.rst     | 119 ++++++++++++++++++
>  tools/hcitool.1       | 255 ---------------------------------------
>  tools/hcitool.rst     | 213 +++++++++++++++++++++++++++++++++
>  tools/hid2hci.1       |  46 -------
>  tools/hid2hci.rst     |  50 ++++++++
>  tools/l2ping.1        |  76 ------------
>  tools/l2ping.rst      |  69 +++++++++++
>  tools/rctest.1        |  90 --------------
>  tools/rctest.rst      |  81 +++++++++++++
>  tools/rfcomm.1        | 113 ------------------
>  tools/rfcomm.rst      | 100 ++++++++++++++++
>  tools/sdptool.1       | 132 --------------------
>  tools/sdptool.rst     | 103 ++++++++++++++++
>  31 files changed, 1701 insertions(+), 1575 deletions(-)
>  delete mode 100644 doc/btmon.txt
>  create mode 100644 monitor/btmon.rst
>  delete mode 100644 src/bluetoothd.8.in
>  create mode 100644 src/bluetoothd.rst.in
>  delete mode 100644 tools/bdaddr.1
>  create mode 100644 tools/bdaddr.rst
>  delete mode 100644 tools/btattach.1
>  create mode 100644 tools/btattach.rst
>  delete mode 100644 tools/ciptool.1
>  create mode 100644 tools/ciptool.rst
>  delete mode 100644 tools/hciattach.1
>  create mode 100644 tools/hciattach.rst
>  delete mode 100644 tools/hciconfig.1
>  create mode 100644 tools/hciconfig.rst
>  delete mode 100644 tools/hcidump.1
>  create mode 100644 tools/hcidump.rst
>  delete mode 100644 tools/hcitool.1
>  create mode 100644 tools/hcitool.rst
>  delete mode 100644 tools/hid2hci.1
>  create mode 100644 tools/hid2hci.rst
>  delete mode 100644 tools/l2ping.1
>  create mode 100644 tools/l2ping.rst
>  delete mode 100644 tools/rctest.1
>  create mode 100644 tools/rctest.rst
>  delete mode 100644 tools/rfcomm.1
>  create mode 100644 tools/rfcomm.rst
>  delete mode 100644 tools/sdptool.1
>  create mode 100644 tools/sdptool.rst
>
> --
> 2.26.3

Applied, thanks.