[geany/geany] 18d273: Update notes for adding a custom filetype

[Nick Treleaven]

Branch:      refs/heads/master
Author:      Nick Treleaven <nick.treleaven at btinternet.com>
Committer:   Nick Treleaven <nick.treleaven at btinternet.com>
Date:        Fri, 11 Oct 2013 15:43:24 UTC
Commit:      18d27364ac9c526527fc7e56ee7f2a4e6effdb4d
             https://github.com/geany/geany/commit/18d27364ac9c526527fc7e56ee7f2a4e6effdb4d

Log Message:
-----------
Update notes for adding a custom filetype


Modified Paths:
--------------
    HACKING

Modified: HACKING
22 files changed, 20 insertions(+), 2 deletions(-)
===================================================================
@@ -384,7 +384,23 @@ Adding a source file foo.[hc] in src/ or plugins/
 Adding a filetype
 -----------------
 You can add a filetype without syntax highlighting or tag parsing, but
-check to see if those features have been written in other projects first.
+check to see if those features have been written in upstream projects
+first (scintilla or ctags).
+
+**Custom:**
+
+If you want to reuse an existing lexer and/or tag parser, making a
+custom filetype is probably easier - it doesn't require any
+changes to the source code. Follow instructions in the manual:
+http://geany.org/manual/geany.html#custom-filetypes. Don't forget to
+update the ``[Groups]`` section in ``filetype_extensions.conf``.
+
+.. warning:
+  You should use the newer `[build-menu]` section for default build
+  commands - the older `[build_settings]` may not work correctly for
+  custom filetypes.
+
+**Built-in:**
 
 * Add GEANY_FILETYPES_FOO to filetypes.h.
 * Initialize GEANY_FILETYPES_FOO in init_builtin_filetypes() of
@@ -392,6 +408,8 @@ check to see if those features have been written in other projects first.
   translation whenever possible.
 * Update data/filetype_extensions.conf.
 
+The remaining notes relate mostly to built-in filetypes.
+
 filetypes.* configuration file
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 All languages need a data/filetypes.foo configuration file. See
@@ -402,7 +420,7 @@ Programming languages should have:
 
 * [keywords] if the lexer supports it.
 * [settings] mostly for comment settings.
-* [build_settings] for commands to run.
+* [build-menu] (or [build_settings]) for commands to run.
 
 For languages with a Scintilla lexer, there should be a [styling] section,
 to correspond to the styles used in highlighting_styles_FOO[] in



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).