Generate Doxygen from configure (#952)
* Generate Doxygen from configure Use case: view the ./configure help text on the web. This has been requested in https://forum.mysensors.org/post/77751 Manually putting the help text in the forum or on mysensors.org would lead to diverging documentation, no version management and extra maintenance burden. This commit attempts to auto-generate the documentation and use existing Doxygen infrastructure to add the help text to the rest of the MySensors documentation.
This commit is contained in:
committed by
Patrick Fallberg
parent
901258f165
commit
adfd9f36f1
+7
-1
@@ -1,6 +1,12 @@
|
|||||||
#!groovy
|
#!groovy
|
||||||
def call(config) {
|
def call(config) {
|
||||||
config.pr.setBuildStatus(config, 'PENDING', 'Toll gate (Documentation)', 'Generating...', '${BUILD_URL}flowGraphTable/')
|
config.pr.setBuildStatus(config, 'PENDING', 'Toll gate (Documentation)', 'Generating...', '${BUILD_URL}flowGraphTable/')
|
||||||
|
// Generate doxygen file for Raspberry Pi configure command
|
||||||
|
sh """#!/bin/bash +x
|
||||||
|
cd ${config.repository_root}
|
||||||
|
echo -e "/**\n * @defgroup RaspberryPiGateway Raspberry Pi Gateway\n * @ingroup MyConfigGrp\n * @brief Configuration options for the Raspberry Pi Gateway\n@{\n@verbatim" > configure.h
|
||||||
|
grep -A999 '<<EOF' configure | grep -B999 EOF | grep -v 'EOF' >> configure.h
|
||||||
|
echo -e "@endverbatim\n@}*/\n" >> configure.h"""
|
||||||
sh """#!/bin/bash +x
|
sh """#!/bin/bash +x
|
||||||
cd ${config.repository_root}
|
cd ${config.repository_root}
|
||||||
export PROJECTNUMBER=\$(
|
export PROJECTNUMBER=\$(
|
||||||
@@ -44,4 +50,4 @@ def call(config) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return this
|
return this
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ Building options:
|
|||||||
--cpu-flags=<CPUFLAGS> CPU defining/optimizing flags to be used. [configure autodetected]
|
--cpu-flags=<CPUFLAGS> CPU defining/optimizing flags to be used. [configure autodetected]
|
||||||
--extra-cflags=<CFLAGS> Extra C flags passed to C compilation. []
|
--extra-cflags=<CFLAGS> Extra C flags passed to C compilation. []
|
||||||
--extra-cxxflags=<CXXFLAGS> Extra C++ flags passed to C++ compilation. []
|
--extra-cxxflags=<CXXFLAGS> Extra C++ flags passed to C++ compilation. []
|
||||||
|
Example: --extra-cxxflags="-DMY_RX_MESSAGE_BUFFER_SIZE=\(32\) -DMY_RF24_DATARATE=\(RF24_2MBPS\)"
|
||||||
--extra-ldflags=<LDFLAGS> Extra C flags passed to linking. []
|
--extra-ldflags=<LDFLAGS> Extra C flags passed to linking. []
|
||||||
--c_compiler=<CC> C compiler. [arm-linux-gnueabihf-gcc][gcc]
|
--c_compiler=<CC> C compiler. [arm-linux-gnueabihf-gcc][gcc]
|
||||||
--cxx_compiler=<CXX> C++ compiler. [arm-linux-gnueabihf-g++][g++]
|
--cxx_compiler=<CXX> C++ compiler. [arm-linux-gnueabihf-g++][g++]
|
||||||
@@ -32,14 +33,13 @@ Building options:
|
|||||||
|
|
||||||
Installation options:
|
Installation options:
|
||||||
--prefix=<PREFIX> Installation prefix path. [/usr/local]
|
--prefix=<PREFIX> Installation prefix path. [/usr/local]
|
||||||
--gateway-dir=<DIR> Gateway files installation directory. [PREFIX/bin]
|
--gateway-dir=<DIR> Gateway files installation directory. [PREFIX/bin]
|
||||||
|
|
||||||
MySensors options:
|
MySensors options:
|
||||||
--my-debug=[enable|disable] Enables or disables MySensors core debugging. [enable]
|
--my-debug=[enable|disable] Enables or disables MySensors core debugging. [enable]
|
||||||
--my-config-file=<FILE> Config file path. [/etc/mysensors.dat]
|
--my-config-file=<FILE> Config file path. [/etc/mysensors.dat]
|
||||||
--my-gateway=[none|ethernet|serial|mqtt]
|
--my-gateway=[none|ethernet|serial|mqtt]
|
||||||
Set the protocol used to communicate with the controller.
|
Set the protocol used to communicate with the controller. [ethernet]
|
||||||
[ethernet]
|
|
||||||
--my-node-id=<ID> Disable gateway feature and run as a node with the specified id.
|
--my-node-id=<ID> Disable gateway feature and run as a node with the specified id.
|
||||||
--my-controller-url-address=<URL>
|
--my-controller-url-address=<URL>
|
||||||
Controller or MQTT broker url.
|
Controller or MQTT broker url.
|
||||||
@@ -62,8 +62,7 @@ MySensors options:
|
|||||||
--my-mqtt-subscribe-topic-prefix=<PREFIX>
|
--my-mqtt-subscribe-topic-prefix=<PREFIX>
|
||||||
MQTT subscribe topic prefix.
|
MQTT subscribe topic prefix.
|
||||||
--my-transport=[none|nrf24|rs485|rfm95|rfm69]
|
--my-transport=[none|nrf24|rs485|rfm95|rfm69]
|
||||||
Set the transport to be used to communicate with other nodes.
|
Set the transport to be used to communicate with other nodes. [nrf24]
|
||||||
[nrf24]
|
|
||||||
--my-rf24-channel=<0-125> RF channel for the sensor net. [76]
|
--my-rf24-channel=<0-125> RF channel for the sensor net. [76]
|
||||||
--my-rf24-pa-level=[RF24_PA_MAX|RF24_PA_LOW]
|
--my-rf24-pa-level=[RF24_PA_MAX|RF24_PA_LOW]
|
||||||
RF24 PA level. [RF24_PA_MAX]
|
RF24 PA level. [RF24_PA_MAX]
|
||||||
@@ -101,7 +100,6 @@ MySensors options:
|
|||||||
relaxed gateway signing requirements.
|
relaxed gateway signing requirements.
|
||||||
--my-signing-password=<PASSWORD>
|
--my-signing-password=<PASSWORD>
|
||||||
If you are using password as the signature type, set your password here.
|
If you are using password as the signature type, set your password here.
|
||||||
|
|
||||||
EOF
|
EOF
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user