debian/README.source

   1 ======================================================
   2 Building the Debian source package for ‘lojban-common’
   3 ======================================================
   4
   5
   6 Upstream provides no versioned files
   7 ====================================
   8
   9 The pristine upstream source is provided as separate files, with no version
  10 for the collection.
  11
  12 The ‘debian/rules’ target “get-orig-source” (as specified in Debian Policy
  13 §4.9) is provided to get the source files from upstream.
  14
  15
  16 Files to install
  17 ----------------
  18
  19 Update the ‘debian/upstream.sha1sums’ file. This file is formatted as per
  20 the input to the ‘sha1sum(1)’ program.
  21
  22 This file is used as input to:
  23
  24 * The ‘debian/get-orig-source’ program, to check the downloaded file
  25   contents: the SHA-1 hash values must match.
  26
  27 * ‘debian/rules’, to determine which files the package will install: every
  28   file to install must be listed.
  29
  30
  31 Package maintenance in VCS
  32 ==========================
  33
  34 The ‘debian/control’ file declares the VCS repository used for
  35 tracking the Debian package maintenance work.
  36
  37
  38 VCS branches for package maintenance
  39 ------------------------------------
  40
  41 The source for the Debian packaging is managed in these conventional
  42 Git branches:
  43
  44 master
  45     The current released code base.
  46
  47 packaging
  48     Debian packaging development branch.
  49
  50 upstream
  51     Upstream source code base, as imported from tarballs.
  52
  53 pristine-tar
  54     Metadata for reproducibly generating upstream tarball.
  55
  56 To build the source package from the Git VCS, use the Debian ‘gitpkg’
  57 tool to generate all the files::
  58
  59     $ git checkout master
  60     $ gitpkg packaging upstream
  61
  62 The ‘dpkg-source’ process will complain about the “deletion” of
  63 upstream source. This is because the upstream source is not present at
  64 all in the ‘packaging’ branch exported, but in the ‘upstream’ branch.
  65 The upstream source is safely exported earlier in its own tarball.
  66
  67 The generated source package is the source control file
  68 ‘../deb-packages/lojban-common/lojban-common_$DEBIANVER.dsc’ and its
  69 associated files in that directory.
  70
  71
  72  -- Ben Finney <bignose@debian.org>, Fri, 12 Aug 2016 17:28:01 +1000
  73
  74 \f
  75 ..
  76     Local variables:
  77     coding: utf-8
  78     mode: text
  79     mode: rst
  80     End:
  81     vim: fileencoding=utf-8 filetype=rst :