Skip to content

Drop obsolete documentation #14309

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

Merged
ktf merged 1 commit into from
May 22, 2025
Merged

Drop obsolete documentation #14309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .cmake-format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,6 @@
"HEADERS": '*',
}
},
"o2_target_man_page": {
"kwargs": {
"NAME": '+',
"SECTION": '*',
}
},
"add_root_dictionary": {
"kwargs": {
"LINKDEF": '+',
Expand Down
3 changes: 0 additions & 3 deletions Algorithm/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@

o2_add_header_only_library(Algorithm INTERFACE_LINK_LIBRARIES O2::Headers)

o2_target_man_page(Algorithm NAME Algorithm SECTION 3)
o2_target_man_page(Algorithm NAME algorithm_parser SECTION 3)

o2_add_test(o2formatparser
SOURCES test/o2formatparser.cxx
COMPONENT_NAME Algorithm
Expand Down
12 changes: 0 additions & 12 deletions Algorithm/doc/Algorithm.3.in
View file
Open in desktop

This file was deleted.

135 changes: 0 additions & 135 deletions Algorithm/doc/algorithm_parser.3.in
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ include(O2AddTestRootMacro)
include(O2ReportNonTestedMacros)
include(O2TargetRootDictionary)
include(O2DataFile)
include(O2TargetManPage)
include(O2AddWorkflow)
include(O2SetROOTPCMDependencies)
include(O2AddHipifiedExecutable)
Expand Down Expand Up @@ -117,10 +116,6 @@ endif()

add_subdirectory(config)

add_custom_target(man ALL)
o2_target_man_page(man NAME o2)
o2_target_man_page(man NAME FairMQDevice)

# Testing and packaging only needed if we are the top level directory
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
# Documentation
Expand Down
2 changes: 0 additions & 2 deletions Examples/Ex5/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,3 @@
o2_add_executable(ex5
SOURCES src/run.cxx
COMPONENT_NAME example TARGETVARNAME targetName)

o2_target_man_page(${targetName} NAME ex5 SECTION 7)
62 changes: 0 additions & 62 deletions Examples/Ex5/doc/ex5.7.in
View file
Open in desktop

This file was deleted.

79 changes: 0 additions & 79 deletions cmake/O2TargetManPage.cmake
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions doc/CMakeInstructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,24 +349,6 @@ Note as well that some (very few) tests are ran only for some configurations
ctest -C RelWithDebInfo
```

#### [Ex5](../Examples/Ex5) Adding a man page

If a module provides one or more executables, it might be of interest for the users of those executables to have access to a man page for them. Ex5 illustates that use case.

.
├── CMakeLists.txt
├── README.md
├── doc
│   └── ex5.7.in
└── src
└── run.cxx

The [man page](ManPages.md) is created using :

o2_target_man_page([targetName] NAME ex5 SECTION 7)

where `NAME xx` refers to a file `doc/xx.[SECTION].in`, and the actual `targetName` can be found from the base target name (ex5 in that case) using the [o2_name_target](../cmake/O2NameTarget.cmake) function.

## CTest

In the build directory of O2, if you launch the `ctest` command, all the O2 tests will be ran, which is not always what you want/need, in particular during development.
Expand Down
Loading