File: README.source

package info (click to toggle)
lojban-common 1.5%2Bdfsg.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 908 kB
  • sloc: sh: 60; makefile: 12
file content (164 lines) | stat: -rw-r--r-- 5,264 bytes parent folder | download
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
156
157
158
159
160
161
162
163
164
======================================================
Building the Debian source package for ‘lojban-common’
======================================================

:Author: Ben Finney <bignose@debian.org>
:Updated: 2022-05-30


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

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


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

* Get the correct upstream source::

      $ debian/get-orig-source

  (See `Upstream provides no versioned files`_ for the rationale of this custom
  download tool.)

* In the ‘main’ 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 ‘main’ 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/1.16.5+dfsg.1-2’, from the HEAD of
  ‘main’.

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

  * Declare a release name, e.g. “* The “Faisal Arefin Dipan” 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 release “1.16.5+dfsg.1-2”.”

* 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 ‘main’ branch.

  * Pull the work-in-progress branch ‘wip/release/1.16.5+dfsg.1-2’ to ‘main’.

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

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

* Upload the successfully-built source package to Debian.

* Prepare the ‘main’ branch for ongoing work:

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

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


Upstream provides no versioned files
====================================

The pristine upstream source is provided as separate files, with no version
for the collection.

The ‘debian/get-orig-source’ program is provided to get the source files from
upstream.


Files to install
----------------

Update the ‘debian/upstream.sha1sums’ file. This file is formatted as per
the input to the ‘sha1sum(1)’ program.

This file is used as input to:

* The ‘debian/get-orig-source’ program, to check the downloaded file
  contents: the SHA-1 hash values must match.

* ‘debian/rules’, to determine which files the package will install: every
  file to install must be listed.


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 “draft correlation between gismu and Roget categories”.

  Files: wordlists/roget.txt
  Copyright:
      © 1991, by the Logical Language Group, Inc.
  License: copy-only-for-promoting-lojban
      All rights reserved. Permission to copy granted subject to your
      verification that this is the latest version of this document,
      that your distribution be for the promotion of Lojban, that
      there is no charge for the product, and that this copyright
      notice is included intact in the copy.


..
    Copyright © 2015–2022 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 :