SF.net SVN: geany: [1795] trunk

[ntrel at users.sourceforge.net]

Revision: 1795
          http://geany.svn.sourceforge.net/geany/?rev=1795&view=rev
Author:   ntrel
Date:     2007-08-14 09:00:13 -0700 (Tue, 14 Aug 2007)

Log Message:
-----------
Add more information for adding a filetype.
2 minor edits.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/HACKING

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2007-08-14 15:36:12 UTC (rev 1794)
+++ trunk/ChangeLog	2007-08-14 16:00:13 UTC (rev 1795)
@@ -11,6 +11,9 @@
    Update filetype_extensions.conf.
  * src/filetypes.c:
    Rewrite filetypes_get_from_uid() for easier maintenance.
+ * HACKING:
+   Add more information for adding a filetype.
+   2 minor edits.
 
 
 2007-08-13  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>

Modified: trunk/HACKING
===================================================================
--- trunk/HACKING	2007-08-14 15:36:12 UTC (rev 1794)
+++ trunk/HACKING	2007-08-14 16:00:13 UTC (rev 1795)
@@ -1,7 +1,7 @@
 About this file
 ---------------
 This file contains information for anyone wanting to work on the Geany codebase.
-You should be aware of the licenses used - see the README file or the documentation.
+You should be aware of the open source licenses used - see the README file or the documentation.
 
 Patches
 -------
@@ -81,10 +81,27 @@
 
 Adding a filetype
 -----------------
-For syntax highlighting, you will need to find (or write) a Scintilla lexer, LexFoo.cxx.
+You can add a filetype without syntax highlighting or tag parsing, but check to see if those
+features have been written elsewhere.
+
+For syntax highlighting, it may be possible to use an existing Scintilla lexer in the scintilla/
+subdirectory - if not, you will need to find (or write) one, LexFoo.cxx. Try the Scintilla project
+first. Remember to update scintilla/Makefile.am and scintilla/makefile.win32.
+
 For tag parsing (e.g. for the symbol list), see 'Adding a TagManager parser' below.
-Add GEANY_FILETYPES_FOO and initialize it in filetypes.[hc].
 
+Add GEANY_FILETYPES_FOO to filetypes.h.
+Initialize GEANY_FILETYPES_FOO in filetypes_init_types() of filetypes.c.
+Rebuild Geany.
+From your geany/ directory, run:
+src/geany --generate-data-files
+
+(The src/ prefix may be different, depending on where the binary is generated.)
+This will update data/filetype_extensions.conf. Note that you need GEANY_DEBUG to be defined when
+building Geany for the --generate-data-files argument to work - this is always defined in the SVN
+version.
+
+
 Adding a TagManager parser
 --------------------------
 This assumes the Geany filetype already exists.
@@ -120,7 +137,7 @@
 Loading a plugin from GDB
 -------------------------
 This is useful so you can load plugins without installing them first.
-Alternatively you can use a symlink to $prefix/lib/geany/myplugin.so, (where
+Alternatively you can use a symlink in ~/.geany/plugins or $prefix/lib/geany (where
 $prefix is /usr/local by default).
 
 The gdb session below was run from the toplevel Geany source directory.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.