Branch: refs/heads/master Author: Colomban Wendling ban@herbesfolles.org Committer: Colomban Wendling ban@herbesfolles.org Date: Sun, 03 Jun 2012 13:09:34 Commit: 9f042521e5ab1958c8274c981ff122b461a3e75f https://github.com/geany/geany/commit/9f042521e5ab1958c8274c981ff122b461a3e7...
Log Message: ----------- Merge branch 'frlan/svn_cleanup'
Modified Paths: -------------- doc/geany.txt doc/plugins.dox scripts/svn-add.sh scripts/svn-changes.sh
Modified: doc/geany.txt 19 files changed, 16 insertions(+), 3 deletions(-) =================================================================== @@ -4985,7 +4985,7 @@ Contributing to this document This document (``geany.txt``) is written in `reStructuredText`__ (or "reST"). The source file for it is located in Geany's ``doc`` subdirectory. If you intend on making changes, you should grab the -source right from SVN to make sure you've got the newest version. After +source right from Git to make sure you've got the newest version. After editing the file, to build the HTML document to see how your changes look, run "``make doc``" in the subdirectory ``doc`` of Geany's source directory. This regenerates the ``geany.html`` file. To generate a PDF @@ -4994,12 +4994,25 @@ geany-|(version)|.pdf.
__ http://docutils.sourceforge.net/rst.html
-After you are happy with your changes, create a patch:: +After you are happy with your changes, create a patch e.g. by using::
- % svn diff geany.txt > foo.patch + % git diff geany.txt > foo.patch + +or even better, by creating a Git-formatted patch which will keep authoring +and description data, by first committing your changes (doing so in a fresh +new branch is recommended for `matser` not to diverge from upstream) and then +using git format-patch:: + + % git checkout -b my-documentation-changes # create a fresh branch + % git commit geany.txt + Write a good commit message... + % git format-patch HEAD^ + % git checkout master # go back to master
and then submit that file to the mailing list for review.
+Also you can clone the Geany repository at GitHub and send a pull request. + Note, you will need the Python docutils software package installed to build the docs. The package is named ``python-docutils`` on Debian and Fedora systems.
Modified: doc/plugins.dox 50 files changed, 25 insertions(+), 25 deletions(-) =================================================================== @@ -84,41 +84,41 @@ * * @subsection code Managing the source code * - * For authors of plugins for Geany, we created a dedicated @a geany-plugins project at - * Sourceforge to ease development of plugins and help new authors. - * Project website: http://sourceforge.net/projects/geany-plugins - * - * Each plugin author is welcome to use these services. To do so, you need an account at - * Sourceforge. You can easily register at (http://sourceforge.net/account/registration/). - * After you successfully created an account, - * tell your account name Enrico or Nick and you will write access to the SVN repository - * (http://geany-plugins.svn.sourceforge.net/viewvc/geany-plugins/). - * Then you can use the repository for your own plugin. - * - * Authors using this service should subscribe to the - * geany-plugins-commits at uvena.de and geany-plugins-tracker at uvena.de - * mailing lists(see my previous post) to stay up to date with changes. - * General plugin discussion can happen on the normal geany at uvena.de or - * geany-devel at uvena.de lists. + * For authors of plugins for Geany, we created a dedicated @a geany-plugins project + * on Sourceforge and GitHub to ease development of plugins and help new authors. + * All information about this project you can find at http://plugins.geany.org/ + * + * To add a new plugin to this project, get in touch with the people on the + * geany-devel-mailing list and create a fork of the geany-plugins project + * at https://github.com/geany/geany-plugins. + * Beside of adding a new plugin, geany-devel-mailing list is also the place where + * to discuss development related questions. + * However, once you have done your fork of geany-plugins you can develop + * your plugin until you think its the right time to publish it. At this point, + * create a pull request for adding your patch set into the master branch of the main + * geany-plugins repository. + * + * Of course, you don't need to use GitHub - any Git is fine. But GitHub + * is making it way easier for review, merging and get in touch with you for + * comments. + * + * If you don't want your plugin to be part of the geany-plugins project it is also fine. + * Just skip the part about forking geany-plugins and sending a pull request. + * In this case it is of course also a good idea to post some kind of announcement + * to geany-devel and maybe to the main geany mailing list -- it's up to you. + * You can also ask for your plugin to be listed on the http://plugins.geany.org/ + * website as a third party plugin, helping Geany user to know about your plugin. * * At time of writing, there are some plugins already available in the - * repository. Feel free to use any of these plugins as a start for your own, + * repositories. Feel free to use any of these plugins as a start for your own, * maybe by copying the directory structure and the autotools files * (Makefile.am, configure.in, ...). Most of the available plugins are also ready for * i18n support, just for reference. * - * New plugins should be imported into a new directory inside the trunk/ - * directory. There are also the common branches and tags directories, use - * them as needed, use always a subdirectory for your own plugin. - * * We encourage authors using this service to only commit changes to their * own plugin and not to others' plugins. Instead just send patches to * geany-devel at uvena.de or the plugin author directly. * - * (the full announcement of this service can be found at - * http://lists.uvena.de/geany/2008-April/003225.html) - * - * * @section paths Installation paths * * - The plugin binary (@c pluginname.so) should be installed in Geany's libdir. This is
Modified: scripts/svn-add.sh 8 files changed, 0 insertions(+), 8 deletions(-) =================================================================== @@ -1,8 +0,0 @@ -#!/bin/sh -FILES=$* -if [ -n "$FILES" ]; then - svn add $FILES - svn propset svn:keywords 'Author Date Id Revision' $FILES - svn propset svn:eol-style native $FILES -fi -echo '>>> Remember to update Makefile.am, makefile.win32, wscript, po/POTFILES.in, geany.nsi (if necessary) <<<'
Modified: scripts/svn-changes.sh 60 files changed, 0 insertions(+), 60 deletions(-) =================================================================== @@ -1,60 +0,0 @@ -#!/bin/sh -# Copyright: 2008, Nick Treleaven -# License: GNU GPL V2 or later -# Warranty: NONE - -# Displays a summary of Subversion working copy changes in ChangeLog -# format, plus warnings about any unknown files. - -# -s for spaces instead of comma separation -if [ "$1" = -s ]; then - SPACES="set" - shift -fi - -# -q to not print warnings -if [ "$1" = -q ]; then - QUIET="set" - shift -fi - -status=`svn st $*` - -# get list of files changed. -# remove extraneous text, e.g. ? entries -files=`echo "$status" |egrep '^[A-Z]'` -# get filenames on one line -files=`echo "$files" |egrep -o '[^A-Z].[ ]+(.+)' |xargs` -# remove ChangeLog -files=`echo "$files" |sed "s/ ChangeLog\b//"` -# add commas if -s argument is not given -if [ -z "$SPACES" ]; then - files=`echo "$files" |sed "s/ /, /g"` -fi - -# show modifications -if [ -n "$files" ]; then - echo 'Changes:' - if [ -z $SPACES ]; then - files="${files}:" - fi - # indent and wrap - OUTFILE=/tmp/fmt - echo -n ' '$files | fmt -w 72 >$OUTFILE - # put ' * ' for first line - cat $OUTFILE | sed '1s/ / * /' -else - echo 'No changes.' -fi - -# warn about anything that isn't a modification or addition -if [ -n "$QUIET" ]; then - exit -fi -warn=`echo "$status" |egrep '^[^MA]'` -if [ -n "$warn" ]; then - echo 'Warnings:' - echo $warn -else - echo 'No warnings.' -fi
@@ Diff output truncated at 100000 characters. @@
-------------- This E-Mail was brought to you by github_commit_mail.py (Source: TBD).