File: README.source

package info (click to toggle)
inform6-library 6.12.2%2Bdfsg.1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 628 kB
  • sloc: ansic: 11,806; sh: 68; makefile: 2
file content (155 lines) | stat: -rw-r--r-- 5,098 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
===================================================
Debian source package for Inform 6 standard library
===================================================

:Author: Ben Finney <bignose@debian.org>
:Updated: 2019-01-31


Pristine upstream source contains non-DFSG-free files
=====================================================

The pristine upstream source contains obfuscated files, that are thereby not
appropriate for use as source files. This violates DFSG §2.

The ‘debian/repack’ program removes those files to create the Debian upstream
source tarball.

The ‘debian/watch’ configuration specifies that ‘uscan --download’ will re-pack
the pristine upstream tarball by running ‘debian/repack’.


Package maintenance in VCS
==========================

The source for the Debian packaging is managed in the ‘master’ branch of the
Git repository.


Work on a release in VCS
------------------------

* Get the correct upstream source, using the ‘get-packaged-orig-source’
  target::

      $ fakeroot debian/rules get-packaged-orig-source

* In the ‘master’ branch, create a new Debian changelog entry.

  Because the release is not complete, many aspects have not been decided and
  should not be recorded in the VCS:

  * The target destination (in the header) is “UNRELEASED”.

  * The person and timestamp of the release is undecided, so should be empty:
    the signature line should have no content, just the “ --” leader.

* While working on the package, temporarily finalise the signature line for
  testing the build.

  This ephemeral state should not be part of the VCS history, though, so do not
  commit that finalised changelog entry; revert it to the above state to
  continue development.


Build the source package from VCS
---------------------------------

* Ensure the ‘master’ branch contains all the changes that are intended for the
  release to Debian.

* Until the work is ready for release, do not commit a finalised Debian
  changelog entry. The changelog entry should be in the state described in
  “Work on a release in VCS”, above.

  This correctly leaves the decision of which destination for the upload, who
  uploads and when, to the point in time where that decision is made: the time
  of finalising the release.

* Rebase a working branch, e.g. ‘wip/release/6.5+dfsg.3-2’, from the HEAD of
  ‘master’.

* In this branch, finalise the ‘debian/changelog’:

  * Declare a release name, e.g. “* The “Zainab al-Khawaja” release.”

  * Set the target distribution, e.g. “unstable”.

  * Set the signature line containing the correct person and timestamp,
    e.g. “Ben Finney <bignose@debian.org>  Tue, 09 Aug 2016 06:05:28 +1000”.

  * Commit the finalised changelog with a commit message of the form
    “Finalise this release.”

* Test the source package:

  * Export the source package::

        $ gbp buildpackage -S

  * Test the source package by building it in a Sbuild or Pbuilder
    environment, with all Lintian checks enabled.

* Only when the package builds satisfactorily from the source package:

  * Switch to the ‘master’ branch.

  * Pull the work-in-progress branch ‘wip/release/4.2+dfsg.1-1’ to ‘master’.

  * Create and sign a tag for the release, ‘release/4.2+dfsg.1-1’ with
    the commit message “Debian release “4.2+dfsg.1-1.”::

        $ git tag --sign \
            --message "Debian release “6.5+dfsg.3-2”." \
            "release/6.5+dfsg.3-2"

* Upload the successfully-built source package to Debian.

* Prepare the ‘master’ branch for ongoing work:

  * Delete the work-in-progress branch ‘wip/release/6.5+dfsg.3-2’.

  * Optionally: Create a new work-in-progress for an upcoming release,
    as described in “Work on a release in VCS”, above.


Omitted components
==================

Components that have been omitted from Debian because they lack a
clear written grant, from the copyright holders, of free-software
license terms in their work:

* The convenience API for Glk:

  Files: infglk.h
  Copyright:
      © 2009–2016 Andrew Plotkin <erkyrath@eblong.com>
  License: all-rights-granted
  License-Grant:
      Written by Andrew Plotkin. This tool is in the public domain.
  Comment:
      This is not the source form of the work, and its corresponding
      source and build tools are not available under free-software
      terms for inclusion in Debian.
      .
      The only tool to build this (‘dispatch_dump’ from the ‘glk-dev’
      code base) itself requires the non-free ‘cheapglk’ library, so
      cannot be in Debian.


..
    Copyright © 2016–2019 Ben Finney <bignose@debian.org>

    This is free software: you may copy, modify, and/or distribute this work
    under the terms of the GNU General Public License as published by the
    Free Software Foundation; version 3 of that license or any later version.
    No warranty expressed or implied.

..
    Local variables:
    coding: utf-8
    mode: rst
    mode: text
    End:
    vim: fileencoding=utf-8 filetype=rst :