doc/HACKING

Code
Comments
Other
Rev Date Author Line
850 17 Nov 09 peter 1 $Id$
850 17 Nov 09 peter 2
850 17 Nov 09 peter 3 This file describes a couple of decisons we have taken and why we have
850 17 Nov 09 peter 4 taken them.
850 17 Nov 09 peter 5
850 17 Nov 09 peter 6 * Consider using Node::log(0) rather than class SVNlog directly
850 17 Nov 09 peter 7
850 17 Nov 09 peter 8    Node::log(0) is recursive in that it returns the union of the log
850 17 Nov 09 peter 9    of *this and its daughters. Naively there should be no difference,
850 17 Nov 09 peter 10    but one counter-example is when a file was created in a branch and
850 17 Nov 09 peter 11    merged into trunk. The log of the file will then contain the
850 17 Nov 09 peter 12    history in the branch while the directory log will only contain the
850 17 Nov 09 peter 13    changeset when the file was merged into trunk (note this is true
850 17 Nov 09 peter 14    for subversion 1.4 but may have changed in later versions merges
850 17 Nov 09 peter 15    are handled differently). Another example is when a file is moved
850 17 Nov 09 peter 16    to another directory. That file log will reflect the entire history
850 17 Nov 09 peter 17    of the file, while the new mother directory of the file only
850 17 Nov 09 peter 18    contain the changeset of the move. As most statistics is recursive
850 17 Nov 09 peter 19    we want to use the recursive log.
850 17 Nov 09 peter 20
850 17 Nov 09 peter 21
850 17 Nov 09 peter 22 * Do not use features in report that requires a web server
850 17 Nov 09 peter 23
850 17 Nov 09 peter 24    It should be possible to view the report in your favorite browser
850 17 Nov 09 peter 25    directly through the file system without a web server. Besides that
850 17 Nov 09 peter 26    it is useful for users, it makes it easier for developers to
850 17 Nov 09 peter 27    inspect the report of the test repository in the regression
850 17 Nov 09 peter 28    test. This decision implies (obviously) that server side includes
850 17 Nov 09 peter 29    (SSI) and any kind of scripts such as java scripts are not allowed
850 17 Nov 09 peter 30    in the generated report.
850 17 Nov 09 peter 31
850 17 Nov 09 peter 32 ----
850 17 Nov 09 peter 33
850 17 Nov 09 peter 34 Copyright (C) 2009 Peter Johansson
850 17 Nov 09 peter 35
850 17 Nov 09 peter 36 This file is part of svndigest, http://dev.thep.lu.se/svndigest
850 17 Nov 09 peter 37
850 17 Nov 09 peter 38 svndigest is free software; you can redistribute it and/or modify it
850 17 Nov 09 peter 39 under the terms of the GNU General Public License as published by the
850 17 Nov 09 peter 40 Free Software Foundation; either version 3 of the License, or (at your
850 17 Nov 09 peter 41 option) any later version.
850 17 Nov 09 peter 42
850 17 Nov 09 peter 43 svndigest is distributed in the hope that it will be useful, but
850 17 Nov 09 peter 44 WITHOUT ANY WARRANTY; without even the implied warranty of
850 17 Nov 09 peter 45 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
850 17 Nov 09 peter 46 General Public License for more details.
850 17 Nov 09 peter 47
850 17 Nov 09 peter 48 You should have received a copy of the GNU General Public License
850 17 Nov 09 peter 49 along with svndigest. If not, see <http://www.gnu.org/licenses/>.

Generated on Thu Jul 20 08:38:23 2023 (UTC) by svndigest 0.12pre (dev build 1672)