HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Grep isn't required for tag file generation; remove replacing c99.tags

Browse Source 
This removes 'Replacing the default C/C++ tags file' - we should
not encourage users to do this as it's unnecessary and error-prone
when updating Geany.
This commit is contained in:
Nick Treleaven 2012-04-24 16:33:31 +01:00
parent 3275d510d8
commit 003185f897
2 changed files with 384 additions and 390 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

740
doc/geany.html
View File

File diff suppressed because it is too large Load Diff

34
doc/geany.txt
View File

@ -1593,6 +1593,8 @@ Different tag attributes like the return value or the argument list
are separated with different characters indicating the type of the are separated with different characters indicating the type of the
following argument. following argument.
Pipe-separated format
*********************
The Pipe-separated format is easier to read and write. The Pipe-separated format is easier to read and write.
There is one tag per line and different tag attributes are separated There is one tag per line and different tag attributes are separated
by the pipe character (``|``). A line looks like:: by the pipe character (``|``). A line looks like::
@ -1637,12 +1639,15 @@ Example for the wxD library for the D programming language::
geany -g wxd.d.tags /home/username/wxd/wx/*.d geany -g wxd.d.tags /home/username/wxd/wx/*.d
*Generating C/C++ tag files:* Generating C/C++ tag files
**************************
You may need to first setup the `C ignore.tags`_ file.
For C/C++ tag files, gcc and grep are required, so that header files For C/C++ tag files gcc is required by default, so that header files
can be preprocessed to include any other headers they depend upon. can be preprocessed to include any other headers they depend upon. If
you do not want this, use the ``-P`` option described above.
For C/C++ files, the environment variable CFLAGS should be set with For preprocessing, the environment variable CFLAGS should be set with
appropriate ``-I/path`` include paths. The following example works with appropriate ``-I/path`` include paths. The following example works with
the bash shell, generating tags for the GnomeUI library:: the bash shell, generating tags for the GnomeUI library::
@ -1653,28 +1658,13 @@ You can adapt this command to use CFLAGS and header files appropriate
for whichever libraries you want. for whichever libraries you want.
*Replacing the default C/C++ tags file:* Generating tag files on Windows
*******************************
Geany currently uses a default global tags file c99.tags for This works basically the same as on other platforms::
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 c99.tags. You should keep a
copy of the generated tags file because it will get overwritten when
upgrading Geany.
*Generating tag files on Windows:*
This works basically the same as on other platforms but you need to make
sure you have grep installed and Geany can find it, i.e. it must be
in the PATH environment variable. To test this, open a console window
and type ``grep`` and see whether it is executed.
If it is, then you can create a tags file like the following::
"c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
C ignore.tags C ignore.tags
^^^^^^^^^^^^^ ^^^^^^^^^^^^^