diff --git a/ChangeLog b/ChangeLog index f4f4a659..d0d81f10 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2007-04-20 Nick Treleaven + + * doc/geany.docbook: + Update generating global tags section. + + 2007-04-19 Enrico Tröger * doc/geany.docbook, src/vte.c: diff --git a/doc/geany.docbook b/doc/geany.docbook index aae36fe7..f33726e8 100644 --- a/doc/geany.docbook +++ b/doc/geany.docbook @@ -956,6 +956,25 @@
Global tags + + Global tags are used to provide autocompletion and calltips without having to open + the corresponding source files. This is intended for library APIs, as the tags file + only has to be updated when you upgrade the library. + + + You can load a global tags file with the Load Tags command, + in the File menu. You can either download these files or generate your own. + These tags files have the filename: + + + libraryname.lang_ext.tags + + + lang_ext is one of the extensions set for the filetype + associated with the tags. See for more + information. + +
Default global tags files For some languages, a list of global tags is loaded when the corresponding filetype is first used. Currently these are for: @@ -967,37 +986,71 @@ LaTeX -
Generating a global tags file +
+
Generating a global tags file - Geany currently uses a file global.tags - for C and C++, commonly installed in /usr/share/geany. This - file can be replaced with one containing tags parsed from a different set of - header files. The following command was used to generate it, from a - bash shell: + Filetypes support + + Currently this is only supported for filetypes that can be pre-processed + with gcc, + i.e. do not use the # character outside of strings. + Also Pascal, PHP and LaTeX will not work yet. + + + This is known to work with C, C++ and D filetypes. + + - CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g global.tags - /usr/include/libgnomeui-2.0/gnome.h - - - - You can adapt this command to use CFLAGS and header files appropriate for - whichever libraries you want. The format is: + You can generate your own global tags files by parsing a list of source files. + The format is: geany -g <Tag File> <File list> - gcc is required, as header files are preprocessed to include + + Tag File should be in the format described + earlier. + File list is a list of filenames, each with + a full path. + + + + gcc is required, as C/C++ header files are preprocessed to include any other header files they depend upon. Currently grep is also required for tags generation. - After creating the file, replace the installed - global.tags file with it and restart - Geany. You should keep a copy of the generated + Example for the wxD library for the D programming language: + geany -g wxd.d.tags /home/username/wxd/wx/*.d + + + For C/C++ files, the environment variable CFLAGS should be set with appropriate + -I/path include paths. + The following example works with the bash shell, generating + tags for the GnomeUI library: + CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags +/usr/include/libgnomeui-2.0/gnome.h + + + You can adapt this command to use CFLAGS and header files appropriate for + whichever libraries you want. + + + Replacing the default C/C++ tags file + + Geany currently uses a default global tags file + global.tags + for C and C++, commonly installed in /usr/share/geany. This + file can be replaced with one containing tags parsed from a different set of + header files. When Geany is next started, your custom + tags file will be loaded instead of the default global.tags. + You should keep a copy of the generated tags file because it will get overwritten when upgrading Geany. + +