Warning, /sdk/kde-dev-scripts/README is written in an unsupported language. File is not indexed.

0001 Stuff in this directory:
0002 
0003 === DEBUGGING SUPPORT
0004 
0005 adddebug        Modifies the Makefile to add debug info (-g)
0006 
0007 add_trace.pl    Modifies a source file to add a trace as the first line
0008                 of every method, using kdDebug, and showing args values.
0009 
0010 kDebug2kdDebug.sh Script to convert old KDE debugging statements to their
0011                 modern equivalents.
0012 
0013 extend_dmalloc  Script to run gdb on return-addresses
0014 
0015 kdekillall      Kills the process "kdeinit: <process> with signal <signal>
0016 
0017 === PROGRAMMING SUPPORT
0018 
0019 cheatmake       Helper for saving time when recompiling, skipping files that
0020                 haven't changed in a meaningful way (e.g. if you only change
0021                 a comment...)
0022 
0023 cmakelint.pl    Looks for problems (simple) in CMakeLists.txt
0024 
0025 create_makefile Create the Makefile in a directory containing a Makefile.am
0026                 Saves time compared to re-running configure completely 
0027 
0028 create_makefiles The recursive version of it - needs create_makefile.
0029 
0030 fixheaders      Adds header files as it recognises make error output
0031 
0032 fixkdeincludes  Tries to reduce the number of includes in KDE source files
0033 
0034 fixuifiles      Fixes up Qt Designer .ui files (version, accels, generated names)
0035                 To use before any commit of a .ui file.
0036 
0037 fixfsfaddr.sed  Script for sed to fix old FSF addresses
0038 
0039 includemocs     Adds missing "#include foobar.moc" lines
0040 
0041 kdedoc          Open a kde help page in kfm/konqueror
0042 
0043 krazy-licensecheck Runs the Krazy2 license checker on a list of source files
0044                    Requires Krazy2.
0045 
0046 kde-spellcheck.pl A script to check source code for misspelings and optionally
0047                 correct them.
0048 
0049 === MODERNIZATION SCRIPTS
0050 
0051 rc2kcfgxt.pl    Reads an existing KConfig rc file and creates a best-guess
0052                 version of a KConfigXT XML file.
0053 
0054 kdelnk2desktop.py Converts old-style .kdelnk files to their modern .desktop
0055                 equivalents.
0056 
0057 qt4/            Directory containing scripts used to automatically convert
0058                 KDE 3 source to the KDE 4 equivalent.
0059 
0060 === USEFUL DATA FOR EXTERNAL PROGRAMS
0061 
0062 kde-devel-emacs.el An emacs file that contains many helpful functions and key bindings
0063                 A must for anyone using [X]Emacs to develop KDE/Qt/C++ applications.
0064 
0065 kde-devel-gdb   A gdb macro definition file, to e.g. print QStrings from gdb.
0066 
0067 kde-devel-vim.vim A vim script that contains many helpful functions and key bindings
0068                 for vim-using KDE developers.
0069 
0070 kde.supp        Some valgrind suppressions handy for ignoring stuff we do not
0071                 care about when valgrinding kde applications
0072 
0073 completions/    Contains useful scripts to enhance the auto-complete feature of some shells.
0074 
0075 === INFORMATION EXTRACTION
0076 
0077 alldcop.rb      Shows an pseudo-XML representation of the DCOP interfaces for
0078                 currently-running KDE applications.  Does not require
0079                 Korundum.
0080 
0081 authors2xml.pl  Extract author information from C++ files and print it out
0082                 in DocBook format as a list
0083 
0084 makeobj         Script around make which basically checks if it is in srcdir
0085                 or in builddir and changes to the right directory for
0086                 calling /usr/bin/make
0087 
0088 extractrc       Extract text tags from designer's UI files and XML GUI-RC files
0089 
0090 extractattr     Same as extractrc, but for use by Scripty.
0091 
0092 findmissingcrystal Looks at Crystal icons to find ones which are still
0093                 unchanged from kdeclassic.
0094 
0095 zonetab2pot.py  Reads a time zone list as its first argument or from
0096                 /usr/share/zoneinfo/zone.tab, and converts it to a PO file
0097                 template.
0098 
0099 kdedoxygen.sh   Script that uses doxygen to generate the API documentation
0100                 in html from the KDE source code.
0101 
0102 kdedoxyman.sh   Script that uses doxygen to generate the API documentation
0103                 in man page format from the KDE source code.
0104 
0105 kdedoxyqt.sh    Script that uses doxygen to generate the API documenation
0106                 in Qt assistant format (.qch) from the KDE source code.
0107                 Requires doxygen v1.5.7 or higher and qthelpgenerator.
0108 
0109 kdemangen.pl    Script to use the output from a KDE application's --author and
0110                 --help-all output to automatically generate a man page for the
0111                 application.
0112 
0113 png2mng.pl      Script to convert a series of numbered .png files into a .mng
0114                 animation.
0115 
0116 package_crystalsvg Script to package all svg files recursively from the current
0117                 directory.
0118 
0119 generate_changelog Script to generate a changelog automatically using the svn
0120                 logs between two revisions.
0121 
0122 rename_source_files Python script to automatically rename a file in Subversion,
0123                 also taking care to rename the file in Makefile.am and updating
0124                 #include lines.
0125 
0126 === SOURCE CONTROL UTILITIES (CVS and Subversion)
0127 === All CVS utilities have a corresponding svn version.
0128 
0129 colorcvs        Colourises CVS commands.
0130 
0131 create_cvsignore Create a .cvsignore file (using the contents of Makefile.am)
0132 
0133 cvs-clean       Recursively wipes out everything not registered in the CVS
0134                 server, starting from the current directory.
0135 
0136 cvs2dist        Create a stand-alone source distribution tarball for an app
0137                 in a KDE CVS module.
0138 
0139 cvsaddcurrentdir Add all files in and below the current dir to CVS.
0140                  *.c, *.h, *.C, *.cpp, *.cc are added automatically,
0141                  *~, *.o, *.so, *.lo, *.la, .libs/, .deps/, .#* are ignored.
0142                  You will be asked for the remaining files.
0143 
0144 cvsblame        Bonsai-like cvs annotate 
0145 
0146 cvscheck        Offline check for status of files in a checked-out module.
0147 
0148 cvsgettags      List the available CVS tags for a given set of files, or
0149                 recursively for all files and directories.  No equivalent for
0150                 svn.
0151 
0152 noncvslist      List all files in a checked out CVS module that are unknown to
0153                 to the CVS server.
0154 
0155 cvsversion      Display CVS version of a file without connecting to the server.
0156 
0157 cxxmetric       Counts lines of code, comments and blank space in C and C++
0158                 source files.
0159 
0160 cvslastchange   launches "cvs diff -u" to display the last applied changes for a
0161                 given file. HEAD branch only.
0162 
0163 cvslastlog      Shows the log associated with the last change on a given file.
0164 
0165 cvsremovealltags Remove all tags from a CVS file. Use with care, and for instance
0166                 after copying a file on the server.
0167 
0168 cvsrevertlast   Reverts all the files given on the command by one version, then
0169                 you can commit them.
0170 
0171 cvsbackport     Back-port the last commit in HEAD, to a branch.
0172 
0173 cvsforwardport  Forward-port the last commit in a branch to HEAD
0174 
0175 pruneemptydirs  Detects stale source dirs in a CVS tree
0176 
0177 cvslastreferenced Goes through the whole history of a file to find all modifications
0178                 referencing a specific string.  It is useful if you want to know
0179                 when a function has been removed/modified/added to a file if a
0180                 recent cvs annotate does not reference it any more. 
0181 
0182 wcgrep Useful for grepping in a subversion working copy.
0183 
0184 === KDE BUILD SCRIPTS
0185 
0186 build-progress.sh Displays the progress of kde-build, times needed to complete each
0187                 step. And sets the title bar of the terminal to the directory that
0188                 make is processing 
0189 
0190 kdesrc-build    Updates and recompiles a local KDE source tree.
0191 
0192 === OTHERS
0193 
0194 gettext.patch   Patch for gettext-0.10.35 to give xgettext the functionality to
0195                 extract scoped messages
0196 
0197 ----------------
0198 Looking to add a script?
0199 
0200 Just add it to this README. For easy man pages see the perlpod man page; the
0201 man page for many of these tools is in the script itself.
0202 
0203 $Id$