debian/README.source

   1                             README.source
   2                             =============
   3
   4 This file contains some remarks about building, upgrading and
   5 customizing the ltp package. Specifically, it contains information
   6 about nonstandard methods used while building the package.
   7
   8                          Getting the package
   9                          -------------------
  10
  11 The preferred way of getting the package is cloning its git
  12 repository, especially if you want to make changes or update to a
  13 newer upstream version. To do it, execute
  14
  15   $ git clone git://repo.or.cz/ltp-debian.git ltp
  16
  17 which will download the repository to directory ltp.
  18
  19                          Building the package
  20                          --------------------
  21
  22 Building the package is easy, just execute
  23
  24   $ git buildpackage
  25
  26 and it should go fine.
  27
  28                        Adding files to packages
  29                        ------------------------
  30
  31 Since many files from the upstream package are not packaged, you may
  32 want to add some files to the packages. Some difficulties you may
  33 encounter:
  34
  35  1) Could be your files are not built by default. In that case, you
  36     will need to change the Makefile(s) in the directory(s) of your
  37     files to include them in the build. Often, that means adding a
  38     directory in the list of subdirectories in parent directory's
  39     Makefile.
  40
  41  2) The list of files installed in the packages is determined during
  42     the build just before installing. That means, you have to build
  43     the package to get full *.install files for the binary
  44     packages. For details, see the file debian/generate-lists. You
  45     will have to edit that file to add files. The procedure
  46     automatically determines if the packages conflict by including
  47     some file twice in different packages. Also, you'll get a list of
  48     files installed by upstream Makefiles in testcases/bin/ not
  49     included in any of the binary packages, which you should
  50     review. Note this is by no means sufficient, because quite often,
  51     files needed to run some testcases (eg. support scripts) are not
  52     installed anywhere.
  53
  54                  Upgrading to newer upstream version
  55                  -----------------------------------
  56
  57 You should really use a git repository for that. The easiest procedure
  58 is running uscan, while in a clean checkout of the master branch:
  59
  60   $ uscan --no-symlink
  61
  62 Be sure to add the --no-symlink parameter, as it would result in
  63 errors while building the package later. This is because the
  64 .orig.tar.gz is repackaged, and this wouldn't happen if it was
  65 symlinked to upstream's tarball.
  66
  67 You should find yourself in the dfsg_clean branch after doing that,
  68 maybe with a few merge conflicts. You should then run
  69
  70   $ debian/dfsg-cleanup
  71
  72 and then
  73
  74   $ git commit                       [if there were merge conflicts]
  75   $ git commit --amend               [if there were none]
  76
  77 The conflicts should be solved by the dfsg-cleanup script.
  78
  79 Next, switch to the mastre branch and merge the new version:
  80
  81   $ git checkout master
  82   $ git merge dfsg_clean
  83
  84 You can get some conflicts in this stage. Good luck dealing with them.
  85
  86 Next, you need to update the copyright file and the rest of the
  87 package. To do this, you need to review the upstream diff, figure out
  88 what's new and changed, and update what needs to be updated. That
  89 means adding newly emerged files to debian/copyright, adding new files
  90 to the binary packages (as described above).
  91
  92
  93 That's all for now
  94
  95   Jiří Paleček