Repository: qpid-dispatch Updated Branches: refs/heads/master fbf6cfca4 -> bb4769aec
DISPATCH-574 - Moved the docs into their respective folders so the qpid-site scripts keep working Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/bb4769ae Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/bb4769ae Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/bb4769ae Branch: refs/heads/master Commit: bb4769aec33fc0551ba577834b635e42367b006e Parents: fbf6cfc Author: Ganesh Murthy <[email protected]> Authored: Wed Nov 23 10:57:42 2016 -0500 Committer: Ganesh Murthy <[email protected]> Committed: Wed Nov 23 10:57:42 2016 -0500 ---------------------------------------------------------------------- doc/CMakeLists.txt | 39 +++++++++++++++++++++++++++--------- doc/asciidoc.conf.in | 2 ++ doc/book/book.adoc | 2 +- doc/book/console_operation.adoc | 2 +- doc/man/qdmanage.8.adoc | 2 +- doc/man/qdrouterd.8.adoc | 2 +- doc/man/qdstat.8.adoc | 2 +- 7 files changed, 36 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 6bc6e73..512b8ff 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -64,13 +64,13 @@ if(BUILD_DOCS) list(APPEND GENERATED_TXT "${output}") endmacro() - schema_gen(${src}/book/schema_txt.py ${bin}/schema.adoc) - schema_gen(${src}/man/qdrouterd.conf.5.py ${bin}/qdrouterd.conf.5.adoc) + schema_gen(${src}/book/schema_txt.py ${bin}/book/schema.adoc) + schema_gen(${src}/man/qdrouterd.conf.5.py ${bin}/man/qdrouterd.conf.5.adoc) # Generate asciidoc .adoc from --help output for man pages macro(help2txt program) get_filename_component(name ${program} NAME) - set(output ${bin}/${name}_help.adoc) + set(output ${bin}/man/${name}_help.adoc) add_custom_command( OUTPUT ${output} COMMAND ${RUN} -s ${src}/man/help2txt.py ${program} --help 1> ${output} @@ -84,21 +84,39 @@ if(BUILD_DOCS) add_custom_target(doc_gen ALL DEPENDS ${GENERATED_TXT}) install(DIRECTORY ${src}/book/ DESTINATION ${QD_DOC_INSTALL_DIR}) - install(FILES ${bin}/schema.adoc DESTINATION ${QD_DOC_INSTALL_DIR}) + + install(FILES ${bin}/book/schema.adoc DESTINATION ${QD_DOC_INSTALL_DIR}) + install(FILES ${bin}/man/qdrouterd.conf.5.adoc DESTINATION ${QD_DOC_INSTALL_DIR}) find_program(ASCIIDOC_EXE asciidoc DOC "Generate HTML documentation") if (ASCIIDOC_EXE) configure_file(${src}/asciidoc.conf.in ${bin}/asciidoc.conf) + configure_file(${src}/index.adoc ${bin}/index.adoc) # Copy the book dir images for HTML viewing in the build directory. # Don't use configure_file since it truncates .png files at 1st ^Z character - EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_directory ${src}/book/ ${bin}) + EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_directory ${src}/book/ ${bin}/book) + EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_directory ${src}/man/ ${bin}/man) + + # Copy the images. Don't use configure_file since it truncates .png files at 1st ^Z character + file(GLOB_RECURSE PNG_SRC RELATIVE ${src} *.png) + foreach(file ${PNG_SRC}) + get_filename_component(name ${file} NAME) + EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${src}/${file} ${bin}/_images/${name}) + endforeach() # Generate HTML file(GLOB_RECURSE ADOC_SRC *.adoc) - foreach(source index book/book man/qdmanage.8 man/qdrouterd.8 man/qdstat.8 ${bin}/qdrouterd.conf.5) + foreach(source index book/book man/qdmanage.8 man/qdrouterd.8 man/qdstat.8 man/qdrouterd.conf.5) get_filename_component(name ${source} NAME) - set(output ${bin}/${name}.html) + get_filename_component(dir ${source} DIRECTORY) + string(FIND ${name} "." dot) + if(dot GREATER 0) + string(LENGTH ${name} length) + MATH(EXPR desired_length "${length}-2") + string(SUBSTRING ${name} "0" ${desired_length} name) + endif(dot GREATER 0) + set(output ${bin}/${dir}/${name}.html) add_custom_command( OUTPUT ${output} ${output}.in # Pretty .html for direct viewing. @@ -106,7 +124,7 @@ if(BUILD_DOCS) # Raw .html.in body for inclusion in Qpid website. COMMAND ${ASCIIDOC_EXE} ${ADOC_FLAGS} -s -o ${output}.in ${source}.adoc DEPENDS ${source}.adoc ${GENERATED_TXT} ${ADOC_SRC} ${bin}/asciidoc.conf - WORKING_DIRECTORY ${src} # Book include links assume we are in source dir. + WORKING_DIRECTORY ${bin} ) list(APPEND DOC_DEPENDS ${output}) install_doc(FILES ${output} DESTINATION ${QD_DOC_INSTALL_DIR}) @@ -115,10 +133,11 @@ if(BUILD_DOCS) find_program(A2X_EXE a2x DOC DOC "Generate Unix man pages") if (A2X_EXE) # Generate man pages. - foreach(source ${src}/man/qdmanage.8 ${src}/man/qdrouterd.8 ${src}/man/qdstat.8 ${bin}/qdrouterd.conf.5) + foreach(source ${bin}/man/qdmanage.8 ${bin}/man/qdrouterd.8 ${bin}/man/qdstat.8 ${bin}/man/qdrouterd.conf.5) get_filename_component(name ${source} NAME) + get_filename_component(dir ${source} DIRECTORY) string(REGEX REPLACE ".*\\.([0-9])$" "\\1" section ${source}) # Man section number - set(output ${bin}/${name}) + set(output ${bin}/${dir}/${name}) add_custom_command( OUTPUT ${output} COMMAND ${A2X_EXE} ${A2X_FLAGS} -f manpage -D ${bin} ${source}.adoc http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/asciidoc.conf.in ---------------------------------------------------------------------- diff --git a/doc/asciidoc.conf.in b/doc/asciidoc.conf.in index 2786135..5371ea9 100644 --- a/doc/asciidoc.conf.in +++ b/doc/asciidoc.conf.in @@ -5,6 +5,8 @@ QD_DOC_INSTALL_DIR=${QD_DOC_INSTALL_DIR} QPID_DISPATCH_VERSION=${QPID_DISPATCH_VERSION} generated=${CMAKE_CURRENT_BINARY_DIR} +generated_book=${CMAKE_CURRENT_BINARY_DIR}/book +generated_man=${CMAKE_CURRENT_BINARY_DIR}/man [footer-text] Qpid Dispatch ${QPID_DISPATCH_VERSION} - generated {localdate} {localtime} http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/book/book.adoc ---------------------------------------------------------------------- diff --git a/doc/book/book.adoc b/doc/book/book.adoc index eae0d17..a51419a 100644 --- a/doc/book/book.adoc +++ b/doc/book/book.adoc @@ -55,7 +55,7 @@ Technical Details and Specifications include::client_compatibility.adoc[] include::addressing.adoc[] include::amqp-mapping.adoc[] -include::{generated}/schema.adoc[] +include::{generated_book}/schema.adoc[] :leveloffset: 0 http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/book/console_operation.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_operation.adoc b/doc/book/console_operation.adoc index 501eee1..233ffc8 100644 --- a/doc/book/console_operation.adoc +++ b/doc/book/console_operation.adoc @@ -34,7 +34,7 @@ The Autostart checkbox, when checked, will automatically log in with the previou Overview page ~~~~~~~~~~~~~ -image:console_overview.png[image] +image:book/console_overview.png[image] On the overview page, aggregate information about routers, addresses, and connections is displayed. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/man/qdmanage.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdmanage.8.adoc b/doc/man/qdmanage.8.adoc index ae9bb59..8c88d33 100644 --- a/doc/man/qdmanage.8.adoc +++ b/doc/man/qdmanage.8.adoc @@ -39,7 +39,7 @@ managed endpoint, not just with qdrouter. OPTIONS ------- -include::{generated}/qdmanage_help.adoc[] +include::{generated_man}/qdmanage_help.adoc[] OPERATIONS ---------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/man/qdrouterd.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdrouterd.8.adoc b/doc/man/qdrouterd.8.adoc index 89c9b2b..5b8ab1d 100644 --- a/doc/man/qdrouterd.8.adoc +++ b/doc/man/qdrouterd.8.adoc @@ -39,7 +39,7 @@ servers. OPTIONS ------- -include::{generated}/qdrouterd_help.adoc[] +include::{generated_man}/qdrouterd_help.adoc[] FILES ----- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/bb4769ae/doc/man/qdstat.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdstat.8.adoc b/doc/man/qdstat.8.adoc index bcd3fcd..ae070dd 100644 --- a/doc/man/qdstat.8.adoc +++ b/doc/man/qdstat.8.adoc @@ -37,7 +37,7 @@ connections, network nodes and links, and router stats such as memory use. OPTIONS ------- -include::{generated}/qdstat_help.adoc[] +include::{generated_man}/qdstat_help.adoc[] OUTPUT COLUMNS -------------- --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
