NETWORK.md: Add a file to indicate what network access is performed.

rvthtool (and other programs included with rvthtool) does not access the
network directly, but may access the network if you attempt to open files
located on network shares.

Install NETWORK.md in the documents directory.

[cmake] options.cmake: Add OPTION(INSTALL_DOC).
This commit is contained in:
David Korth 2025-06-01 13:11:52 -04:00
parent 6d70248b7d
commit a823d358d6
3 changed files with 23 additions and 1 deletions

View File

@ -176,7 +176,9 @@ ENDIF(ENABLE_NLS)
# Project subdirectories.
ADD_SUBDIRECTORY(extlib)
ADD_SUBDIRECTORY(src)
ADD_SUBDIRECTORY(doc)
IF(INSTALL_DOC)
ADD_SUBDIRECTORY(doc)
ENDIF(INSTALL_DOC)
# TODO: Print build summary indicating what plugins will be built.
# (Some other project had something like this...)
@ -198,6 +200,16 @@ SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
SET(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
#SET(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_SOURCE_DIR}/doc/WELCOME.txt")
IF(INSTALL_DOC)
# Additional document files for the root directory.
# TODO: Convert from Unix line endings to Windows when
# compiling for Windows?
INCLUDE(DirInstallPaths)
INSTALL(FILES NETWORK.md
DESTINATION "${DIR_INSTALL_DOC_ROOT}"
COMPONENT "doc")
ENDIF(INSTALL_DOC)
# CPack: Source package settings.
# NOTE: Double-escape is required because the unescaped
# string # is written to CPackSourceConfig.cmake, which

7
NETWORK.md Normal file
View File

@ -0,0 +1,7 @@
# Network Access Information
rvthtool, and other programs included with rvthtool (qrvthtool, wadresign,
and nusresign) do not have any code to access any network services.
If you use rvthtool (or other included programs) to access files on a network
share, it will use OS-provided facilities to access those files.

View File

@ -52,3 +52,6 @@ OPTION(ENABLE_NLS "Enable NLS using Qt's built-in localization system." ON)
IF(CMAKE_SYSTEM_NAME STREQUAL "Linux")
OPTION(ENABLE_NIXOS "Enable special handling for NixOS builds." OFF)
ENDIF(CMAKE_SYSTEM_NAME STREQUAL "Linux")
# Install documentation
OPTION(INSTALL_DOC "Install documentation." ON)