Merge lp:~stefanor/ubuntu-packaging-guide/program-spelling into lp:ubuntu-packaging-guide

Proposed by Stefano Rivera
Status: Merged
Merged at revision: 79
Proposed branch: lp:~stefanor/ubuntu-packaging-guide/program-spelling
Merge into: lp:ubuntu-packaging-guide
Diff against target: 329 lines (+44/-44)
9 files modified
chroots.rst (+1/-1)
debian-dir-overview.rst (+1/-1)
getting-set-up.rst (+1/-1)
kde.rst (+3/-3)
libraries.rst (+15/-15)
packaging-new-software.rst (+5/-5)
patches-to-packages.rst (+12/-12)
security-and-stable-release-updates.rst (+3/-3)
udd-patchsys.rst (+3/-3)
To merge this branch: bzr merge lp:~stefanor/ubuntu-packaging-guide/program-spelling
Reviewer Review Type Date Requested Status
Andrew Starr-Bochicchio Approve
Review via email: mp+95778@code.launchpad.net

Description of the change

As far as I know, the spelling "programme" is rarely used for computer programs in UK english. We use the US "program" instead.

Also, some other bits.

To post a comment you must log in.
Revision history for this message
Andrew Starr-Bochicchio (andrewsomething) wrote :

Looks good. Thanks for fixing this up!

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'chroots.rst'
--- chroots.rst 2011-08-31 04:02:50 +0000
+++ chroots.rst 2012-03-04 13:07:19 +0000
@@ -57,7 +57,7 @@
57SBuild is a system similar to PBuilder for creating an environment to run test package builds in. It closer matches that used by Launchpad for building packages but takes some more setup compared to PBuilder. See `the Security Team Build Environment wiki page`_ for a full explanation.57SBuild is a system similar to PBuilder for creating an environment to run test package builds in. It closer matches that used by Launchpad for building packages but takes some more setup compared to PBuilder. See `the Security Team Build Environment wiki page`_ for a full explanation.
5858
59Full virtual machines can be useful for packaging and testing59Full virtual machines can be useful for packaging and testing
60programmes. TestDrive is a program to automate syncing and running60programs. TestDrive is a program to automate syncing and running
61daily ISO images, see `the TestDrive wiki page`_ for more information.61daily ISO images, see `the TestDrive wiki page`_ for more information.
6262
63You can also set up pbuilder to pause when it comes across a build63You can also set up pbuilder to pause when it comes across a build
6464
=== modified file 'debian-dir-overview.rst'
--- debian-dir-overview.rst 2012-02-25 16:08:29 +0000
+++ debian-dir-overview.rst 2012-03-04 13:07:19 +0000
@@ -257,7 +257,7 @@
257257
258In the first case, the ``install`` file should have one line per file 258In the first case, the ``install`` file should have one line per file
259installed, 259installed,
260specifying both the the file and the installation directory. For example, the 260specifying both the file and the installation directory. For example, the
261following ``install`` file would install the script ``foo`` in the source 261following ``install`` file would install the script ``foo`` in the source
262package's 262package's
263root directory to ``usr/bin`` and a desktop file in the ``debian`` directory to 263root directory to ``usr/bin`` and a desktop file in the ``debian`` directory to
264264
=== modified file 'getting-set-up.rst'
--- getting-set-up.rst 2011-08-31 04:02:50 +0000
+++ getting-set-up.rst 2012-03-04 13:07:19 +0000
@@ -81,7 +81,7 @@
8181
82GPG will first ask you which kind of key you want to generate. Choosing the82GPG will first ask you which kind of key you want to generate. Choosing the
83default (RSA and DSA) is fine. Next it will ask you about the keysize. The83default (RSA and DSA) is fine. Next it will ask you about the keysize. The
84default (currently 2048) is fine, but 4096 is more secure. Afterward, it will84default (currently 2048) is fine, but 4096 is more secure. Afterwards, it will
85ask you if you want it to expire the key at some stage. It is safe to say "0",85ask you if you want it to expire the key at some stage. It is safe to say "0",
86which means the key will never expire. The last questions will be about your86which means the key will never expire. The last questions will be about your
87name and email address. Just pick the ones you are going to use for Ubuntu87name and email address. Just pick the ones you are going to use for Ubuntu
8888
=== modified file 'kde.rst'
--- kde.rst 2011-08-31 04:02:50 +0000
+++ kde.rst 2012-03-04 13:07:19 +0000
@@ -2,7 +2,7 @@
2KDE Packaging2KDE Packaging
3=============3=============
44
5Packaging of KDE programmes in Ubuntu is managed by the Kubuntu and5Packaging of KDE programs in Ubuntu is managed by the Kubuntu and
6MOTU teams. You can contact the Kubuntu team on the `Kubuntu mailing6MOTU teams. You can contact the Kubuntu team on the `Kubuntu mailing
7list`_ and ``#kubuntu-devel`` Freenode IRC channl. More information7list`_ and ``#kubuntu-devel`` Freenode IRC channl. More information
8about Kubuntu development is on the `Kubuntu wiki page`_.8about Kubuntu development is on the `Kubuntu wiki page`_.
@@ -14,7 +14,7 @@
14Patching Policy14Patching Policy
15---------------15---------------
1616
17Kubuntu does not add patches to KDE programmes unless they come from17Kubuntu does not add patches to KDE programs unless they come from
18the upstream authors or submitted upstream with the expectation they18the upstream authors or submitted upstream with the expectation they
19will be merged soon or we have consulted the issue with the upstream19will be merged soon or we have consulted the issue with the upstream
20authors.20authors.
@@ -67,7 +67,7 @@
67these together manually, contact `dpm`_ to do this.67these together manually, contact `dpm`_ to do this.
6868
69If a package is moved from universe to main it will need to be69If a package is moved from universe to main it will need to be
70reuploaded before the translations get imported into Launchpad.70re-uploaded before the translations get imported into Launchpad.
7171
72``.desktop`` files also need translations. We patch KDELibs to read72``.desktop`` files also need translations. We patch KDELibs to read
73translations out of ``.po`` files which are pointed to by a line73translations out of ``.po`` files which are pointed to by a line
7474
=== modified file 'libraries.rst'
--- libraries.rst 2011-10-03 13:31:26 +0000
+++ libraries.rst 2012-03-04 13:07:19 +0000
@@ -3,13 +3,13 @@
3================3================
44
5Shared libraries are compiled code which is intended to be shared5Shared libraries are compiled code which is intended to be shared
6among several different programmes. They are distributed as ``.so``6among several different programs. They are distributed as ``.so``
7files in ``/usr/lib/``. 7files in ``/usr/lib/``.
88
9A library exports symbols which are the compiled versions of9A library exports symbols which are the compiled versions of
10functions, classes and variables. A library has a name called an10functions, classes and variables. A library has a name called an
11SONAME which includes a version number. This SONAME version does not11SONAME which includes a version number. This SONAME version does not
12necessarily match the public release version number. A programme gets12necessarily match the public release version number. A program gets
13compiled against a given SONAME version of the library. If any of the13compiled against a given SONAME version of the library. If any of the
14symbols is removed or changes then the version number needs to be14symbols is removed or changes then the version number needs to be
15changed which forces any packages using that library to be recompiled15changed which forces any packages using that library to be recompiled
@@ -19,15 +19,15 @@
19packagers have to keep separate version numbers.19packagers have to keep separate version numbers.
2020
21Libraries are usually distributed by upstream as standalone releases. Sometimes21Libraries are usually distributed by upstream as standalone releases. Sometimes
22they are distributed as part of a programme. In this case they can be included22they are distributed as part of a program. In this case they can be included
23in the binary package along with the programme (this is called bundling) if you23in the binary package along with the program (this is called bundling) if you
24do not expect any other programmes to use the library, more often they should be24do not expect any other programs to use the library, more often they should be
25split out into separate binary packages.25split out into separate binary packages.
2626
27The libraries themselves are put into a binary package named ``libfoo1`` where27The libraries themselves are put into a binary package named ``libfoo1`` where
28``foo`` is the name of the library and ``1`` is the version from the SONAME. 28``foo`` is the name of the library and ``1`` is the version from the SONAME.
29Development files from the package, such as header files, needed to compile29Development files from the package, such as header files, needed to compile
30programmes against the library are put into a package called ``libfoo-dev``.30programs against the library are put into a package called ``libfoo-dev``.
3131
3232
33An Example33An Example
@@ -64,12 +64,12 @@
6464
65The last one is the actual library, complete with minor and point version65The last one is the actual library, complete with minor and point version
66number. The first one is a symlink which points to the actual library. The66number. The first one is a symlink which points to the actual library. The
67symlink is what programmes using the library will look for, the running67symlink is what programs using the library will look for, the running
68programmes do not care about the minor version number.68programs do not care about the minor version number.
6969
70``libnova-dev.install`` includes all the files needed to compile a programme70``libnova-dev.install`` includes all the files needed to compile a program
71with this library. Header files, a config binary, the ``.la`` libtool file and71with this library. Header files, a config binary, the ``.la`` libtool file and
72``libnova.so`` which is another symlink pointing at the library, programmes72``libnova.so`` which is another symlink pointing at the library, programs
73compiling against the library do not care about the major version number73compiling against the library do not care about the major version number
74(although the binary they compile into will).74(although the binary they compile into will).
7575
@@ -82,11 +82,11 @@
82----------------82----------------
8383
84The -dev package also ships ``usr/lib/libnova.a``. This is a static library,84The -dev package also ships ``usr/lib/libnova.a``. This is a static library,
85an alternative to the shared library. Any programme compiled against the85an alternative to the shared library. Any program compiled against the
86static library will include the code directory into itself. This gets round86static library will include the code directory into itself. This gets round
87worrying about binary compatibility of the library. However it also means that87worrying about binary compatibility of the library. However it also means that
88any bugs, including security issues, will not be updated along with the libary88any bugs, including security issues, will not be updated along with the library
89until the programme is recompiled. For this reason programmes using static89until the program is recompiled. For this reason programs using static
90libraries are discouraged.90libraries are discouraged.
9191
9292
@@ -94,11 +94,11 @@
94------------94------------
9595
96When a package builds against a library the ``shlibs`` mechanism will add a96When a package builds against a library the ``shlibs`` mechanism will add a
97package dependency on that library. This is why most programmes will have97package dependency on that library. This is why most programs will have
98``Depends: ${shlibs:Depends}`` in ``debian/control``. That gets replaced with98``Depends: ${shlibs:Depends}`` in ``debian/control``. That gets replaced with
99the library dependencies at build time. However shlibs can only make it depend99the library dependencies at build time. However shlibs can only make it depend
100on the major ABI version number, ``2`` in our libnova example, so if new symbols100on the major ABI version number, ``2`` in our libnova example, so if new symbols
101get added in libnova 2.1 a programme using these symbols could still be101get added in libnova 2.1 a program using these symbols could still be
102installed against libnova ABI 2.0 which would then crash.102installed against libnova ABI 2.0 which would then crash.
103103
104To make the library dependencies more precise we keep ``.symbols`` files that104To make the library dependencies more precise we keep ``.symbols`` files that
105105
=== modified file 'packaging-new-software.rst'
--- packaging-new-software.rst 2011-12-02 18:49:07 +0000
+++ packaging-new-software.rst 2012-03-04 13:07:19 +0000
@@ -8,8 +8,8 @@
8creating a package for Ubuntu or a PPA. This guide will take you through the 8creating a package for Ubuntu or a PPA. This guide will take you through the
9steps of packaging new software.9steps of packaging new software.
1010
11Checking the Programme11Checking the Program
12----------------------12--------------------
1313
14The first stage in packaging is to get the released tar from upstream (we call14The first stage in packaging is to get the released tar from upstream (we call
15the authors of applications "upstream") and check that it compiles and runs.15the authors of applications "upstream") and check that it compiles and runs.
@@ -52,7 +52,7 @@
52 $ sudo apt-get install libqrencode-dev libzbar-dev libzbarqt-dev52 $ sudo apt-get install libqrencode-dev libzbar-dev libzbarqt-dev
53 $ make53 $ make
5454
55If the compile completes successfully you can install and run the programme::55If the compile completes successfully you can install and run the program::
5656
57 $ sudo make install57 $ sudo make install
58 $ kqrcode58 $ kqrcode
@@ -97,7 +97,7 @@
97 Build-Depends: debhelper (>= 7.0.50~), cmake, libqt4-dev, kdelibs5-dev,97 Build-Depends: debhelper (>= 7.0.50~), cmake, libqt4-dev, kdelibs5-dev,
98 libqrencode-dev, libzbar-dev, libzbarqt-dev98 libqrencode-dev, libzbar-dev, libzbarqt-dev
9999
100You will also need to fill in a description of the programme in the100You will also need to fill in a description of the program in the
101``Description:`` field.101``Description:`` field.
102102
103``copyright`` needs to be filled in to follow the licence of the upstream103``copyright`` needs to be filled in to follow the licence of the upstream
@@ -204,7 +204,7 @@
204204
205 - `Debian Developer's Reference, 5.1. New packages`_ - The entire 205 - `Debian Developer's Reference, 5.1. New packages`_ - The entire
206 document is invaluable for both Ubuntu and Debian packagers. This206 document is invaluable for both Ubuntu and Debian packagers. This
207 section documents processes for sumbitting new packages.207 section documents processes for submitting new packages.
208208
209In some cases, it might make sense to go directly into Ubuntu first. For209In some cases, it might make sense to go directly into Ubuntu first. For
210instance, Debian might be in a freeze making it unlikely that you're210instance, Debian might be in a freeze making it unlikely that you're
211211
=== modified file 'patches-to-packages.rst'
--- patches-to-packages.rst 2011-07-25 12:30:46 +0000
+++ patches-to-packages.rst 2012-03-04 13:07:19 +0000
@@ -69,32 +69,32 @@
69To add a new patch you need to tell Quilt to create a new patch, tell it which69To add a new patch you need to tell Quilt to create a new patch, tell it which
70files that patch should change, edit the files then refresh the patch::70files that patch should change, edit the files then refresh the patch::
7171
72 $ quilt new kubuntu_02_programme_description.diff72 $ quilt new kubuntu_02_program_description.diff
73 Patch kubuntu_02_programme_description.diff is now on top73 Patch kubuntu_02_program_description.diff is now on top
74 $ quilt add src/main.cpp74 $ quilt add src/main.cpp
75 File src/main.cpp added to patch kubuntu_02_programme_description.diff75 File src/main.cpp added to patch kubuntu_02_program_description.diff
76 $ sed -i "s,Webcam picture retriever,Webcam snapshot programme,"76 $ sed -i "s,Webcam picture retriever,Webcam snapshot program,"
77 src/main.cpp77 src/main.cpp
78 $ quilt refresh78 $ quilt refresh
79 Refreshed patch kubuntu_02_programme_description.diff79 Refreshed patch kubuntu_02_program_description.diff
8080
81The ``quilt add`` step is important, if you forget it the files will not end up81The ``quilt add`` step is important, if you forget it the files will not end up
82in the patch.82in the patch.
8383
84The change will now be in84The change will now be in
85``debian/patches/kubuntu_02_programme_description.diff`` and the ``series``85``debian/patches/kubuntu_02_program_description.diff`` and the ``series``
86file will have had the new patch added to it. You should add the new file to86file will have had the new patch added to it. You should add the new file to
87the packaging::87the packaging::
8888
89 $ bzr add debian/patches/kubuntu_02_programme_description.diff89 $ bzr add debian/patches/kubuntu_02_program_description.diff
90 $ bzr add .pc/*90 $ bzr add .pc/*
91 $ dch -i "Add patch kubuntu_02_programme_description.diff to improve the programme description"91 $ dch -i "Add patch kubuntu_02_program_description.diff to improve the program description"
92 $ bzr commit92 $ bzr commit
9393
94Quilt keeps its metadata in the ``.pc/`` directory, so currently you need to94Quilt keeps its metadata in the ``.pc/`` directory, so currently you need to
95add that to the packaging too. This should be improved in future.95add that to the packaging too. This should be improved in future.
9696
97As a general rule you should be careful adding patches to programmes unless97As a general rule you should be careful adding patches to programs unless
98they come from upstream, there is often a good reason why that change has not98they come from upstream, there is often a good reason why that change has not
99already been made. The above example changes a user interface string for99already been made. The above example changes a user interface string for
100example, so it would break all translations. If in doubt, do ask the upstream100example, so it would break all translations. If in doubt, do ask the upstream
@@ -135,13 +135,13 @@
135Then carry on::135Then carry on::
136136
137 $ quilt push137 $ quilt push
138 Applied kubuntu_02_programme_description.diff138 Applied kubuntu_02_program_description.diff
139139
140It is a good idea to run refresh, this will update the patch relative to the140It is a good idea to run refresh, this will update the patch relative to the
141changed upstream source::141changed upstream source::
142142
143 $ quilt refresh143 $ quilt refresh
144 Refreshed patch kubuntu_02_programme_description.diff144 Refreshed patch kubuntu_02_program_description.diff
145145
146Then commit as usual::146Then commit as usual::
147147
@@ -164,7 +164,7 @@
164164
165Other patch systems used by packages include ``dpatch`` and ``cdbs165Other patch systems used by packages include ``dpatch`` and ``cdbs
166simple-patchsys``, these work similarly to Quilt by keeping patches in166simple-patchsys``, these work similarly to Quilt by keeping patches in
167debian/patches but have different commands to apply, unapply or create patches.167debian/patches but have different commands to apply, un-apply or create patches.
168You can use ``edit-patch``, shown in previous chapters, as a reliable way to168You can use ``edit-patch``, shown in previous chapters, as a reliable way to
169work with all systems.169work with all systems.
170170
171171
=== modified file 'security-and-stable-release-updates.rst'
--- security-and-stable-release-updates.rst 2011-08-31 04:02:50 +0000
+++ security-and-stable-release-updates.rst 2012-03-04 13:07:19 +0000
@@ -54,7 +54,7 @@
5454
55 $ patch -p1 < /home/user/dbus-vulnerability.diff55 $ patch -p1 < /home/user/dbus-vulnerability.diff
5656
57Aftering making the necessary changes, you just hit Ctrl-D or type exit to57After making the necessary changes, you just hit Ctrl-D or type exit to
58leave the temporary shell.58leave the temporary shell.
5959
60Formatting the changelog and patches60Formatting the changelog and patches
@@ -62,7 +62,7 @@
6262
63After applying your patches you will want to update the changelog. The ``dch``63After applying your patches you will want to update the changelog. The ``dch``
64command is used to edit the ``debian/changelog`` file and ``edit-patch`` will64command is used to edit the ``debian/changelog`` file and ``edit-patch`` will
65launch ``dch`` automatically after unapplying all the patches. If you are not65launch ``dch`` automatically after un-applying all the patches. If you are not
66using ``edit-patch``, you can launch ``dch -i`` manually. Unlike with regular66using ``edit-patch``, you can launch ``dch -i`` manually. Unlike with regular
67patches, you should use the following format (note the distribution name uses67patches, you should use the following format (note the distribution name uses
68lucid-security since this is a security update for Lucid) for security68lucid-security since this is a security update for Lucid) for security
@@ -127,7 +127,7 @@
127loss. Due to the potential for such updates to themselves introduce bugs we127loss. Due to the potential for such updates to themselves introduce bugs we
128only allow this where the change can be easily understood and verified.128only allow this where the change can be easily understood and verified.
129129
130The process for Stable Release Updates is just the same as the proccess for130The process for Stable Release Updates is just the same as the process for
131security bugs except you should subscribe ``ubuntu-sru`` to the bug.131security bugs except you should subscribe ``ubuntu-sru`` to the bug.
132132
133The update will go into the ``proposed`` archive (for example133The update will go into the ``proposed`` archive (for example
134134
=== modified file 'udd-patchsys.rst'
--- udd-patchsys.rst 2012-01-31 23:04:43 +0000
+++ udd-patchsys.rst 2012-03-04 13:07:19 +0000
@@ -47,7 +47,7 @@
47With newer versions of Bazaar as mentioned above, merging new Debian versions47With newer versions of Bazaar as mentioned above, merging new Debian versions
48to Ubuntu versions should be quite easy now, even when one or both packages48to Ubuntu versions should be quite easy now, even when one or both packages
49have quilt patches. Just use ``bzr merge`` as you normally would. Under the49have quilt patches. Just use ``bzr merge`` as you normally would. Under the
50hood, Bazaar will first unapply all the patches, then do the merge, then if50hood, Bazaar will first un-apply all the patches, then do the merge, then if
51there are no conflicts, it will re-apply the patches leaving you again with a51there are no conflicts, it will re-apply the patches leaving you again with a
52source branch in the ``quilt push -a`` state.52source branch in the ``quilt push -a`` state.
5353
@@ -61,7 +61,7 @@
61 $ cd precise61 $ cd precise
62 $ bzr merge ../wheezy62 $ bzr merge ../wheezy
6363
64If there are merge conflicts, the quilt patches will remain unapplied so that64If there are merge conflicts, the quilt patches will remain un-applied so that
65you can resolve the conflicts more easily. You would use a combination of bzr65you can resolve the conflicts more easily. You would use a combination of bzr
66and quilt commands to resolve the conflicts, until all the quilt patches are66and quilt commands to resolve the conflicts, until all the quilt patches are
67applied again. Then you're ready to commit, push, and build as you normally67applied again. Then you're ready to commit, push, and build as you normally
@@ -147,7 +147,7 @@
147the UDD source branch importer `currently includes any existing .pc147the UDD source branch importer `currently includes any existing .pc
148directory`_ in the imported branch. This can cause conflicts, or other148directory`_ in the imported branch. This can cause conflicts, or other
149unwanted or unknown changes because you've essentially got two conflicting149unwanted or unknown changes because you've essentially got two conflicting
150version control systems competing for the same thing (i.e. bzr and quilt3).150version control systems competing for the same thing (i.e. bzr and quilt).
151For now, the best recommendation is to revert any changes to the ``.pc``151For now, the best recommendation is to revert any changes to the ``.pc``
152directory in your branch.152directory in your branch.
153153

Subscribers

People subscribed via source and target branches