From 19d0bdfe0c89381ce0bc28c61a9f960a4f568009 Mon Sep 17 00:00:00 2001
From: Azat Khuzhin <azat@libevent.org>
Date: Sun, 4 Oct 2020 22:56:30 +0300
Subject: [PATCH] Change prefix for man pages from "le_" to "libevent_"
As pointed by @kloczek:
"With only two characters it would be harder to guess under what kind of name are libevent lvl 3 man pages.
Longer name with bash/fix/zsh tab competition should not be a problem :)"
Refs: #1099
---
cmake/RenameDoxygen.cmake | 8 ++++----
cmake/UseDoxygen.cmake | 2 +-
doxygen.am | 8 ++++----
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/cmake/RenameDoxygen.cmake b/cmake/RenameDoxygen.cmake
index 43a75af4..3260c3d2 100644
--- a/cmake/RenameDoxygen.cmake
+++ b/cmake/RenameDoxygen.cmake
@@ -1,9 +1,9 @@
-# Add prefix "le_" for manual pages
+# Add prefix "libevent_" for manual pages
message(STATUS "Rename man pages in ${CMAKE_BINARY_DIR}")
# Remove old pages to avoid stalled copies
-file(GLOB LIBEVENT_MAN_PAGES RELATIVE ${CMAKE_BINARY_DIR} le_*)
+file(GLOB LIBEVENT_MAN_PAGES RELATIVE ${CMAKE_BINARY_DIR} libevent_*)
list(LENGTH LIBEVENT_MAN_PAGES LEN)
if (${LEN} GREATER 0)
file(REMOVE ${LIBEVENT_MAN_PAGES})
@@ -11,7 +11,7 @@ endif()
# Create new
file(GLOB LIBEVENT_MAN_PAGES RELATIVE ${CMAKE_BINARY_DIR} *)
-list(FILTER LIBEVENT_MAN_PAGES EXCLUDE REGEX ^le_.*$)
+list(FILTER LIBEVENT_MAN_PAGES EXCLUDE REGEX ^libevent_.*$)
foreach(MAN_PAGE ${LIBEVENT_MAN_PAGES})
- file(RENAME ${CMAKE_BINARY_DIR}/${MAN_PAGE} ${CMAKE_BINARY_DIR}/le_${MAN_PAGE})
+ file(RENAME ${CMAKE_BINARY_DIR}/${MAN_PAGE} ${CMAKE_BINARY_DIR}/libevent_${MAN_PAGE})
endforeach()
diff --git a/cmake/UseDoxygen.cmake b/cmake/UseDoxygen.cmake
index 83a98011..c7e4b175 100644
--- a/cmake/UseDoxygen.cmake
+++ b/cmake/UseDoxygen.cmake
@@ -97,7 +97,7 @@ macro(UseDoxygen)
if ("${DOXYGEN_GENERATE_MAN}" STREQUAL "YES")
set(MAN_PAGES_DIR ${PROJECT_BINARY_DIR}/${DOXYGEN_OUTPUT_DIRECTORY}/man/man3)
- # Add prefix "le_" for manual pages
+ # Add prefix "libevent_" for manual pages
add_custom_target(doxygen-rename-man-pages ALL
COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/RenameDoxygen.cmake
DEPENDS doxygen
diff --git a/doxygen.am b/doxygen.am
index f53ec482..5c5d164f 100644
--- a/doxygen.am
+++ b/doxygen.am
@@ -20,7 +20,7 @@ clean-local:
if ENABLE_DOXYGEN_MAN
man3_MAN_DIR = @DX_DOCDIR@/man/man3
-# add "le_" prefix for man pages
+# add "libevent_" prefix for man pages
#
# XXX: we cannot clean old man pages here since
# doxygen-rename-man-pages will be called twice:
@@ -30,14 +30,14 @@ man3_MAN_DIR = @DX_DOCDIR@/man/man3
#
# Once this will be solved add the following to the target:
#
-# -rm -fr $(man3_MAN_DIR)/le_*
+# -rm -fr $(man3_MAN_DIR)/libevent_*
doxygen-rename-man-pages: doxygen-doc
echo "Rename man pages in $(man3_MAN_DIR)"
@for p in $(man3_MAN_DIR)/*; do \
p=`basename $$p`; \
- p_strip=$${p/le_/}; \
+ p_strip=$${p/libevent_/}; \
if [ ! "$$p_strip" = "$$p" ]; then continue; fi; \
- mv '$(man3_MAN_DIR)/'$$p '$(man3_MAN_DIR)/'le_$$p; \
+ mv '$(man3_MAN_DIR)/'$$p '$(man3_MAN_DIR)/'libevent_$$p; \
done
# integrate doxygen with automake targets
--
2.40.0