diff options
author | Bernd Hufmann | 2012-11-26 14:04:56 +0000 |
---|---|---|
committer | Bernd Hufmann | 2012-11-28 14:48:58 +0000 |
commit | 87a43b7c150eda36f21ddf79caa370f365be8441 (patch) | |
tree | 2c16345333e276b6e09d445e12dea8a2afe0ab6a /lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png | |
parent | 5f6d0623b0bf348ba1c74389d1b34693047a8a91 (diff) | |
download | org.eclipse.linuxtools-87a43b7c150eda36f21ddf79caa370f365be8441.tar.gz org.eclipse.linuxtools-87a43b7c150eda36f21ddf79caa370f365be8441.tar.xz org.eclipse.linuxtools-87a43b7c150eda36f21ddf79caa370f365be8441.zip |
Change LTTng help plugin generation
The generation of the LTTng help plugin used to be done from
a wiki stored at Eclipse.org. This wiki matches the latest
delivered source code. However, when developing new features
or updating existing features it is required to document the
new or updated feature. But this cannot be done on the wiki
web page. This causes that the writing of documentation
is often postponed before the next official release.
This commit changes the way the help plugin is build. The source
wiki text file along with the relevant images as part of are
stored as part of the git repository. The build-helper.xml was
updated to build the help from the local wiki file. This allows
the designer to update the documentation along with the feature
implementation. Note, that the local wiki can be edited with the
MyLyn wiki text editor.
When a release to open source is done and these new or updated
feature are part of it, then the open source wiki at Eclipse.org
needs to be aligned to the wiki which is stored in the git
repository.
How to know if someone updated the open source wiki independent to
the one in the git repository? For that, the build-helper.xml file
also builds the help plugin files as it used to be done. After a
Ant build with the build-helper.xml file the changes will show
as changes in the git repository. Knowing what changed, it can be
easily transfered to the local wiki stored in git.
Note that the legacy help files were removed from the repository.
Change-Id: Iba1b140a78a5e4aaa2b2a7ffbdb0cf852f9b6030
Reviewed-on: https://git.eclipse.org/r/8794
Tested-by: Hudson CI
Reviewed-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
IP-Clean: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Tested-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Diffstat (limited to 'lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png')
-rw-r--r-- | lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png | bin | 63012 -> 0 bytes |
1 files changed, 0 insertions, 0 deletions
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png b/lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png Binary files differdeleted file mode 100644 index b2ab8778bc..0000000000 --- a/lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/images/TmfEvents-Search.png +++ /dev/null |