source: branches/src-highlight/doc/HACKING @ 1112

Last change on this file since 1112 was 1100, checked in by Peter Johansson, 11 years ago

merge trunk to src-highlight

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