Skip to content

Commit a5378ff

Browse files
committed
Drop obsolete documentation
1 parent 546f793 commit a5378ff

File tree

13 files changed

+0
-455
lines changed

13 files changed

+0
-455
lines changed

.cmake-format.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,6 @@
6666
"HEADERS": '*',
6767
}
6868
},
69-
"o2_target_man_page": {
70-
"kwargs": {
71-
"NAME": '+',
72-
"SECTION": '*',
73-
}
74-
},
7569
"add_root_dictionary": {
7670
"kwargs": {
7771
"LINKDEF": '+',

Algorithm/CMakeLists.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@
1111

1212
o2_add_header_only_library(Algorithm INTERFACE_LINK_LIBRARIES O2::Headers)
1313

14-
o2_target_man_page(Algorithm NAME Algorithm SECTION 3)
15-
o2_target_man_page(Algorithm NAME algorithm_parser SECTION 3)
16-
1714
o2_add_test(o2formatparser
1815
SOURCES test/o2formatparser.cxx
1916
COMPONENT_NAME Algorithm

Algorithm/doc/Algorithm.3.in

Lines changed: 0 additions & 12 deletions
This file was deleted.

Algorithm/doc/algorithm_parser.3.in

Lines changed: 0 additions & 135 deletions
This file was deleted.

CMakeLists.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ include(O2AddTestRootMacro)
8686
include(O2ReportNonTestedMacros)
8787
include(O2TargetRootDictionary)
8888
include(O2DataFile)
89-
include(O2TargetManPage)
9089
include(O2AddWorkflow)
9190
include(O2SetROOTPCMDependencies)
9291
include(O2AddHipifiedExecutable)
@@ -117,10 +116,6 @@ endif()
117116

118117
add_subdirectory(config)
119118

120-
add_custom_target(man ALL)
121-
o2_target_man_page(man NAME o2)
122-
o2_target_man_page(man NAME FairMQDevice)
123-
124119
# Testing and packaging only needed if we are the top level directory
125120
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
126121
# Documentation

Examples/Ex5/CMakeLists.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,3 @@
1212
o2_add_executable(ex5
1313
SOURCES src/run.cxx
1414
COMPONENT_NAME example TARGETVARNAME targetName)
15-
16-
o2_target_man_page(${targetName} NAME ex5 SECTION 7)

Examples/Ex5/doc/ex5.7.in

Lines changed: 0 additions & 62 deletions
This file was deleted.

cmake/O2TargetManPage.cmake

Lines changed: 0 additions & 79 deletions
This file was deleted.

doc/CMakeInstructions.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -349,24 +349,6 @@ Note as well that some (very few) tests are ran only for some configurations
349349
ctest -C RelWithDebInfo
350350
```
351351

352-
#### [Ex5](../Examples/Ex5) Adding a man page
353-
354-
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.
355-
356-
.
357-
├── CMakeLists.txt
358-
├── README.md
359-
├── doc
360-
│   └── ex5.7.in
361-
└── src
362-
└── run.cxx
363-
364-
The [man page](ManPages.md) is created using :
365-
366-
o2_target_man_page([targetName] NAME ex5 SECTION 7)
367-
368-
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.
369-
370352
## CTest
371353

372354
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.

0 commit comments

Comments
 (0)