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

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