source: trunk/lib/yat/README @ 795

Last change on this file since 795 was 795, checked in by Peter Johansson, 12 years ago

refs #388

Create a sub-directory 'lib/yat' in which files from yat are
placed. The files may be updated via 'make fetch', see file README for
more details on how to change which files are updated/copied through
this mechanism.

The reason we do not use subversion's external mechanism is that we
don't want the files to be synchronised with yat automatically. We
want the update to be moderated by some developer.

I chose to fetch files using the svn client rather than wget because
the svn allows us to get an Id string with information from the yat
repository. 'wget' would just download the file as it appears on the
server that is the string is not expanded.

The file 'config_public.h' is created by configure just as in
yat. This implies that automake adds $(top_builddir)/lib/yat to the
include path so unless in a VPATH build $(top_srcdir)/lib/yat is in
the include path. As we have already added $(top_srcdir)/lib to the
include path, and there are both a lib/utility.h and a
lib/yat/utility.h it is not obvious which file is included when having
'include "utility.h"'. For this reason, when being in bin/ and test/
it is needed to include "../lib/utility.h" rather than "utility.h"
when we want to include 'lib/utility.h'.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.5 KB
Line 
1$Id: README 795 2009-06-30 03:57:27Z peter $
2
3This directory contains files that belong to the yat project. For more
4information on the yat project please refer to
5http://dev.thep.lu.se/yat.
6
7Developers may update to the latest revision of yat via `make
8fetch'. Be careful doing this and particularly in sensitive branches
9such as a stable-branch. All files are left pristine except
10`Exception.h' that is modified to avoid a dependency to GSL.
11
12How to add a new file from yat? Add the file to 'noinst_HEADERS' or
13'libyat_a_SOURCES' as appropriate. Check that file only includes
14standard header files and yat header files already present here. Issue
15'make fecth' and set svndigest:ignore="" and svn:keywords="". The
16latter is to clarify that the 'Id' string that appears in the file
17contains information related to the yat repository and not svndigest
18repository.
19
20
21Copyright (C) 2009 Peter Johansson
22
23This file is part of svndigest, http://dev.thep.lu.se/svndigest
24
25svndigest is free software; you can redistribute it and/or modify it
26under the terms of the GNU General Public License as published by
27the Free Software Foundation; either version 3 of the License, or
28(at your option) any later version.
29
30svndigest is distributed in the hope that it will be useful, but
31WITHOUT ANY WARRANTY; without even the implied warranty of
32MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
33General Public License for more details.
34
35You should have received a copy of the GNU General Public License
36along with svndigest. If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the repository browser.