Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-11 07:34:32 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/cmake/Docs.cmake

106 lines
5.3 KiB
CMake
Raw Normal View History

Factor out building lexicon_filter into separate script This adds a new script build_tools/build_lexicon_filter.sh that builds the lexicon filter. It is factored out from the Makefile, and both the Makefile and CMake build invoke it.
2017-09-12 05:58:49 +00:00
# Files in ./share/completions/
FILE(GLOB COMPLETIONS_DIR_FILES share/completions/*.fish)
# Files in ./share/functions/
FILE(GLOB FUNCTIONS_DIR_FILES share/functions/*.fish)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
# Files in doc_src
FILE(GLOB DOC_SRC_FILES doc_src/*)
# .txt files in doc_src
FILE(GLOB HELP_SRC doc_src/*.txt)
# These files are the source files, they contain a few @FOO@-style substitutions.
# Note that this order defines the order that they appear in the documentation.
SET(HDR_FILES_SRC doc_src/index.hdr.in doc_src/tutorial.hdr doc_src/design.hdr
doc_src/license.hdr doc_src/commands.hdr.in doc_src/faq.hdr)
# These are the generated result files.
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
STRING(REPLACE ".in" "" HDR_FILES "${HDR_FILES_SRC}")
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
# Header files except for index.hdr
SET(HDR_FILES_NO_INDEX ${HDR_FILES})
LIST(REMOVE_ITEM HDR_FILES_NO_INDEX doc_src/index.hdr)
# Copy doc_src files
FILE(COPY ${DOC_SRC_FILES} DESTINATION doc_src)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
# Build lexicon_filter.
Factor out building lexicon_filter into separate script This adds a new script build_tools/build_lexicon_filter.sh that builds the lexicon filter. It is factored out from the Makefile, and both the Makefile and CMake build invoke it.
2017-09-12 05:58:49 +00:00
ADD_CUSTOM_COMMAND(OUTPUT lexicon_filter
COMMAND build_tools/build_lexicon_filter.sh
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
${CMAKE_CURRENT_SOURCE_DIR}/share/functions/
${CMAKE_CURRENT_SOURCE_DIR}/share/completions/
< ${CMAKE_CURRENT_SOURCE_DIR}/lexicon_filter.in
Factor out building lexicon_filter into separate script This adds a new script build_tools/build_lexicon_filter.sh that builds the lexicon filter. It is factored out from the Makefile, and both the Makefile and CMake build invoke it.
2017-09-12 05:58:49 +00:00
> ${CMAKE_CURRENT_BINARY_DIR}/lexicon_filter
&& chmod a+x ${CMAKE_CURRENT_BINARY_DIR}/lexicon_filter
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
DEPENDS ${FUNCTIONS_DIR_FILES} ${COMPLETIONS_DIR_FILES}
doc_src/commands.hdr ${CMAKE_CURRENT_SOURCE_DIR}/lexicon_filter.in
Factor out building lexicon_filter into separate script This adds a new script build_tools/build_lexicon_filter.sh that builds the lexicon filter. It is factored out from the Makefile, and both the Makefile and CMake build invoke it.
2017-09-12 05:58:49 +00:00
share/functions/__fish_config_interactive.fish
build_tools/build_lexicon_filter.sh)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
ADD_CUSTOM_TARGET(build_lexicon_filter DEPENDS lexicon_filter)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
#
# commands.dr collects documentation on all commands, functions and
# builtins
#
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_src)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
ADD_CUSTOM_COMMAND(OUTPUT doc_src/commands.hdr
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
COMMAND build_tools/build_commands_hdr.sh ${HELP_SRC}
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
< doc_src/commands.hdr.in
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
> ${CMAKE_CURRENT_BINARY_DIR}/doc_src/commands.hdr
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
DEPENDS ${HELP_SRC}
${CMAKE_CURRENT_SOURCE_DIR}/doc_src/commands.hdr.in
${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_commands_hdr.sh)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
# doc.h is a compilation of the various snipptes of text used both for
# the user documentation and for internal help functions into a single
# file that can be parsed by Doxygen to generate the user
# documentation.
ADD_CUSTOM_COMMAND(OUTPUT doc.h
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
COMMAND cat ${HDR_FILES} > ${CMAKE_CURRENT_BINARY_DIR}/doc.h
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
DEPENDS ${HDR_FILES})
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
# toc.txt: $(HDR_FILES:index.hdr=index.hdr.in) build_tools/build_toc_txt.sh | show-SED
# FISH_BUILD_VERSION=${FISH_BUILD_VERSION} build_tools/build_toc_txt.sh \
# $(HDR_FILES:index.hdr=index.hdr.in) > toc.txt
# Note we would like to add doc_src/index.hdr.in as a dependency but CMake replaces this with
# doc_src/index.hdr; CMake bug?
ADD_CUSTOM_COMMAND(OUTPUT toc.txt
COMMAND env `cat ${FBVF}` ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_toc_txt.sh
doc_src/index.hdr.in ${HDR_FILES_NO_INDEX}
> ${CMAKE_CURRENT_BINARY_DIR}/toc.txt
DEPENDS ${FBVF} ${HDR_FILES_NO_INDEX})
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
# doc_src/index.hdr: toc.txt doc_src/index.hdr.in | show-AWK
# @echo " AWK CAT $(em)$@$(sgr0)"
# $v cat $@.in | $(AWK) '{if ($$0 ~ /@toc@/){ system("cat toc.txt");} else{ print $$0;}}' >$@
ADD_CUSTOM_COMMAND(OUTPUT doc_src/index.hdr
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_index_hdr.sh toc.txt
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
< doc_src/index.hdr.in
> ${CMAKE_CURRENT_BINARY_DIR}/doc_src/index.hdr
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
DEPENDS toc.txt)
Factor out script to build index.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_index_hdr.sh that builds the index.hdr file. Invoke it from both the Makefile and CMake build.
2017-10-05 04:20:32 +00:00
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
# doc: $(HDR_FILES_SRC) Doxyfile.user $(HTML_SRC) $(HELP_SRC) doc.h $(HDR_FILES) lexicon_filter
# @echo " doxygen $(em)user_doc$(sgr0)"
# $v (cat Doxyfile.user; echo INPUT_FILTER=./lexicon_filter; echo PROJECT_NUMBER=$(FISH_BUILD_VERSION) | $(SED) "s/-.*//") | doxygen - && touch user_doc
# $v rm -f $(wildcard $(addprefix ./user_doc/html/,arrow*.png bc_s.png bdwn.png closed.png doc.png folder*.png ftv2*.png nav*.png open.png splitbar.png sync_*.png tab*.* doxygen.* dynsections.js jquery.js pages.html))
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
ADD_CUSTOM_TARGET(doc
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
COMMAND env `cat ${FBVF}`
Factor out script to build user_doc As part of factoring out the documentation building parts of the fish build, add a new file build_user_doc.sh that builds the user_doc directory. Invoke it from both the Makefile and CMake build.
2017-10-05 04:26:34 +00:00
${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_user_doc.sh
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.user ./lexicon_filter
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
DEPENDS ${FBVF} Doxyfile.user ${DOC_SRC_FILES} doc.h ${HDR_FILES} lexicon_filter)
Factor out script to build commands.hdr As part of factoring out the documentation building parts of the fish build, add a new file build_commands_hdr.sh that builds the commands.hdr file. Invoke it from both the Makefile and CMake build.
2017-09-17 22:01:15 +00:00
Additional work on building docs with CMake
2017-10-05 04:30:20 +00:00
ADD_CUSTOM_COMMAND(OUTPUT share/man/
COMMAND env `cat ${FBVF}`
INPUT_FILTER=lexicon_filter ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_documentation.sh ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.help doc_src ./share
DEPENDS ${FBVF} ${HELP_SRC} ${CMAKE_CURRENT_BINARY_DIR}/lexicon_filter)
ADD_CUSTOM_TARGET(BUILD_MANUALS ALL DEPENDS share/man/)
Improve IDE grouping in the CMake build This adds intelligent groups and hides unused files when generating IDE projects (Xcode, CLion, etc) in the CMake build.
2017-10-05 04:40:58 +00:00
# Group docs targets into a DocsTargets folder
SET_PROPERTY(TARGET doc BUILD_MANUALS
PROPERTY FOLDER cmake/DocTargets)
Reference in a new issue Copy permalink