summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2020-05-21 16:18:26 +0200
committerSlávek Banko <slavek.banko@axis.cz>2020-05-26 15:02:33 +0200
commiteb30e07ba19e45de980c0f86e8b39078621023a5 (patch)
tree291987d8584f0aeefab59363b2aedd98e79c8e97
parent970528b7299b0bd73b663e0b73eca25abb382c76 (diff)
downloadkscope-eb30e07ba19e45de980c0f86e8b39078621023a5.tar.gz
kscope-eb30e07ba19e45de980c0f86e8b39078621023a5.zip
Add a man page.
Move the kscope.desktop file into XDG_APPS_INSTALL_DIR directory, see TDE/tde#26 and bug 2408. Delete empty folder templates. Signed-off-by: gregory guy <gregory-tde@laposte.net> (cherry picked from commit 368ee23e036f50097ed148eaedfbead308a7ff26)
-rw-r--r--CMakeLists.txt10
-rw-r--r--doc/CMakeLists.txt2
-rw-r--r--doc/en/CMakeLists.txt2
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/kscope.176
-rw-r--r--po/CMakeLists.txt14
-rw-r--r--src/CMakeLists.txt13
-rw-r--r--templates/cpp26
-rw-r--r--templates/h26
9 files changed, 110 insertions, 64 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6e59733..c9a1b1a 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -48,9 +48,9 @@ option( WITH_GCC_VISIBILITY "Enable fvisibility and fvisibility-inlines-hidden"
##### user requested modules
-option( BUILD_ALL "Build all" ON )
-option( BUILD_DOC "Build documentation" ${BUILD_ALL} )
-option( BUILD_TRANSLATIONS "Build translations" ${BUILD_ALL} )
+option( BUILD_ALL "Build all" ON )
+option( BUILD_DOC "Build documentation" ${BUILD_ALL} )
+option( BUILD_TRANSLATIONS "Build translations" ${BUILD_ALL} )
##### configure checks
@@ -70,8 +70,8 @@ set( CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--no-undefined"
##### directories
add_subdirectory( src )
-#tde_conditional_add_subdirectory( BUILD_DOC doc )
-#tde_conditional_add_subdirectory( BUILD_TRANSLATIONS po )
+tde_conditional_add_subdirectory( BUILD_DOC doc )
+tde_conditional_add_subdirectory( BUILD_TRANSLATIONS po )
##### write configure files
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..d08a511
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,2 @@
+
+tde_auto_add_subdirectories()
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
new file mode 100644
index 0000000..94cfac3
--- /dev/null
+++ b/doc/en/CMakeLists.txt
@@ -0,0 +1,2 @@
+
+tde_create_handbook( DESTINATION ${PROJECT_NAME} )
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/kscope.1 b/doc/man/kscope.1
new file mode 100644
index 0000000..d11f8b6
--- /dev/null
+++ b/doc/man/kscope.1
@@ -0,0 +1,76 @@
+'\" -*- coding: us-ascii -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH kscope 1 2006-02-18 "" ""
+.SH NAME
+kscope \- a source browsing and editing environment
+.SH SYNOPSIS
+'nh
+.fi
+.ad l
+\fBkscope\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[
+\fB\fIQt-options\fB\fR
+] [
+\fB\fITDE-options\fB\fR
+]
+'in \n(.iu-\nxu
+.ad b
+'hy
+.SH DESCRIPTION
+KScope is a source browsing and editing environment for large projects written
+in C (such as the Linux kernel).
+.PP
+KScope uses the Cscope code analysis engine to provide valuable information to
+coders.
+.PP
+KScope also provides call-tree and call-graph views that can help developers
+by visualising the relationships between different functions in the code base.
+.SH OPTIONS
+All TDE and Qt
+programs accept a some common command-line options. KScope has no
+application-specific options.
+.PP
+.TP
+\*(T<\fB\-\-help\fR\*(T>
+Show help about options
+.TP
+\*(T<\fB\-\-help\-qt\fR\*(T>
+Show Qt specific options
+.TP
+\*(T<\fB\-\-help\-tde\fR\*(T>
+Show TDE specific options
+.TP
+\*(T<\fB\-\-help\-all\fR\*(T>
+Show all options
+.TP
+\*(T<\fB\-\-author\fR\*(T>
+Show author information
+.TP
+\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-version\fR\*(T>
+Show version information
+.TP
+\*(T<\fB\-\-license\fR\*(T>
+Show license information
+.TP
+\*(T<\fB\-\-\fR\*(T>
+Indicates end of options
+.SH AUTHOR
+KScope was written by Elad Lahav <\*(T<elad_lahav@users.sf.net\*(T>>.
+.SH COPYRIGHT
+This manual page was written by Jonathan Patrick Davies
+<\*(T<jpatrick@ubuntu.com\*(T>> for the
+Ubuntu system (but may be used by others).
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU General Public License,
+Version 2 or any later version published by the Free Software Foundation.
+.PP
+On Debian systems, the complete text of the GNU General Public
+License can be found in
+\*(T<\fI/usr/share/common\-licenses/GPL\fR\*(T>.
diff --git a/po/CMakeLists.txt b/po/CMakeLists.txt
new file mode 100644
index 0000000..75c89f8
--- /dev/null
+++ b/po/CMakeLists.txt
@@ -0,0 +1,14 @@
+file( GLOB_RECURSE po_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.po )
+string( REGEX REPLACE "[ \r\n\t]+" ";" _linguas "$ENV{LINGUAS}" )
+
+foreach( _po ${po_files} )
+ get_filename_component( _lang ${_po} NAME_WE )
+ if( "${_linguas}" MATCHES "^;*$" OR ";${_linguas};" MATCHES ";${_lang};" )
+ if( "${_po}" MATCHES "^([^/]*)/.*" )
+ string( REGEX REPLACE "^([^/]*)/.*" "\\1" _component "${_po}" )
+ else( )
+ set( _component "${PROJECT_NAME}" )
+ endif( )
+ tde_create_translation( FILES ${_po} LANG ${_lang} OUTPUT_NAME ${_component} )
+ endif( )
+endforeach( )
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 12efd27..ad91146 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -9,6 +9,7 @@ include_directories(
link_directories(
${TQT_LIBRARY_DIRS}
+ ${TDE_LIB_DIR}
)
tde_import( kate )
@@ -101,23 +102,21 @@ tde_add_executable( kscope AUTOMOC
##### icons
-tde_install_icons( kscope )
+tde_install_icons( ${PROJECT_NAME} )
##### other data
+tde_create_translated_desktop( ${PROJECT_NAME}.desktop )
+
install(
FILES kscopeui.rc kscope_config
- DESTINATION ${DATA_INSTALL_DIR}/kscope
+ DESTINATION ${DATA_INSTALL_DIR}/${PROJECT_NAME}
)
install(
FILES file_ro.png file_rw.png file_save.png query_locked.png
query_unlocked.png tab_list.png call_graph.png called_tree.png
calling_tree.png bookmark.png
- DESTINATION ${DATA_INSTALL_DIR}/kscope/pics
-)
-
-install( FILES kscope.desktop
- DESTINATION ${APPS_INSTALL_DIR}/Development
+ DESTINATION ${DATA_INSTALL_DIR}/${PROJECT_NAME}/pics
)
diff --git a/templates/cpp b/templates/cpp
deleted file mode 100644
index adfe0fd..0000000
--- a/templates/cpp
+++ /dev/null
@@ -1,26 +0,0 @@
-/***************************************************************************
- *
- * Copyright (C) $YEAR$ $AUTHOR$ ($EMAIL$)
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS'' AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ***************************************************************************/
diff --git a/templates/h b/templates/h
deleted file mode 100644
index adfe0fd..0000000
--- a/templates/h
+++ /dev/null
@@ -1,26 +0,0 @@
-/***************************************************************************
- *
- * Copyright (C) $YEAR$ $AUTHOR$ ($EMAIL$)
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS'' AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ***************************************************************************/