Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markdown-ify the bladeRF-cli interactive help #270

Closed
wants to merge 5 commits into from
Closed

Markdown-ify the bladeRF-cli interactive help #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
446d183
Markdown-ify the bladeRF-cli interactive help
Jul 4, 2014
05639fd
Clean up excessively long lines in help file
Jul 4, 2014
c1435f9
Use tables for help, to make things more pretty
Jul 4, 2014
6067d89
Fix up help formatting, grammar, and spelling
Jul 6, 2014
2a53817
Reduce man page rendering warnings
Jul 6, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion debian/control
View file
Open in desktop
@@ -1,7 +1,7 @@
Source: bladerf
Priority: extra
Maintainer: Ryan Tucker <rtucker@gmail.com>
Build-Depends: debhelper (>=9), cmake (>= 2.8.5), pkg-config, doxygen, libusb-1.0-0-dev (>= 1.0.12), libtecla1-dev, libncurses5-dev, git, help2man
Build-Depends: debhelper (>=9), cmake (>= 2.8.5), pkg-config, doxygen, libusb-1.0-0-dev (>= 1.0.12), libtecla1-dev, libncurses5-dev, git, help2man, pandoc
Standards-Version: 3.9.4
Section: comm
Homepage: http://www.nuand.com/bladeRF
Expand Down
41 changes: 30 additions & 11 deletions host/utilities/bladeRF-cli/CMakeLists.txt
View file
Open in desktop
Expand Up @@ -21,6 +21,32 @@ configure_file(
@ONLY
)

################################################################################
# Regenerate interactive help
################################################################################
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/src/cmd/doc)
find_program(PANDOC_EXECUTABLE pandoc)

if(PANDOC_EXECUTABLE)
# Run the generation script
message(STATUS "Will use pandoc to generate interactive help")
add_custom_command(
OUTPUT src/cmd/doc/cmd_help.h src/cmd/doc/cmd_help.man
COMMAND bash ${CMAKE_CURRENT_SOURCE_DIR}/src/cmd/doc/generate.bash ${CMAKE_CURRENT_SOURCE_DIR}/src/cmd/doc/interactive-help.md
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/src/cmd/doc
)
else(PANDOC_EXECUTABLE)
# Re-use old cmd_help.h and cmd_help.man
message(STATUS "Could not find pandoc. Interactive help may be out of date.")
add_custom_command(
OUTPUT src/cmd/doc/cmd_help.h
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/src/cmd/doc/cmd_help.h.in ${CMAKE_CURRENT_BINARY_DIR}/src/cmd/doc/cmd_help.h
)
add_custom_command(
OUTPUT src/cmd/doc/cmd_help.man
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/src/cmd/doc/cmd_help.man.in ${CMAKE_CURRENT_BINARY_DIR}/src/cmd/doc/cmd_help.man
)
endif(PANDOC_EXECUTABLE)
################################################################################
# Build dependencies
################################################################################
Expand Down Expand Up @@ -63,6 +89,7 @@ set(CLI_INCLUDE_DIRS
${CMAKE_CURRENT_SOURCE_DIR}/src/cmd
${CMAKE_CURRENT_SOURCE_DIR}/src/input
${CMAKE_CURRENT_BINARY_DIR}/src
${CMAKE_CURRENT_BINARY_DIR}/src/cmd
${BLADERF_HOST_COMMON_INCLUDE_DIRS}
${libbladeRF_SOURCE_DIR}/include
${BLADERF_FW_COMMON_INCLUDE_DIR}
Expand Down Expand Up @@ -101,6 +128,7 @@ set(BLADERF_CLI_SOURCE
src/common.c
src/cmd/calibrate.c
src/cmd/calibrate_dc.c
src/cmd/doc/cmd_help.h
src/cmd/cmd.c
src/cmd/erase.c
src/cmd/flash_common.c
Expand Down Expand Up @@ -210,22 +238,13 @@ if(BUILD_BLADERF_CLI_DOCUMENTATION)
set(MAN_INSTALL_DIR share/man)
endif(NOT DEFINED MAN_INSTALL_DIR)

# Build interactive commands summary, for inclusion in man page
add_custom_command(
OUTPUT bladeRF-cli_auto.h2m
DEPENDS bladeRF-cli
COMMAND bash ${CMAKE_CURRENT_SOURCE_DIR}/../doc/include_man/get-interactive-commands.bash
${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/bladeRF-cli > bladeRF-cli_auto.h2m
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)

# Build actual man page
add_custom_command(
OUTPUT bladeRF-cli.1
DEPENDS bladeRF-cli bladeRF-cli_auto.h2m
DEPENDS bladeRF-cli src/cmd/doc/cmd_help.man
COMMAND ${HELP2MAN_EXECUTABLE} --no-info
--opt-include=${CMAKE_CURRENT_SOURCE_DIR}/../doc/include_man/bladeRF-cli.h2m
--opt-include=${CMAKE_CURRENT_BINARY_DIR}/bladeRF-cli_auto.h2m
--opt-include=${CMAKE_CURRENT_BINARY_DIR}/src/cmd/doc/cmd_help.man
--opt-include=${CMAKE_CURRENT_SOURCE_DIR}/../doc/include_man/common.h2m
--output=bladeRF-cli.1 ./bladeRF-cli
WORKING_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
Expand Down