Bug#918384: dgit: typo suggestions in man pages
-BEGIN PGP SIGNED MESSAGE- Hash: SHA512 Dear Ian, The patches I submitted for Debian bug #918384 were created entirely by me, except for those changes Sean suggested that I incorporated in the second patch set. Attached is a signed Developer's Certificate of Origin for your records. Thank you, Paul Hardy unifoun...@unifoundry.com -BEGIN PGP SIGNATURE- iQIzBAEBCgAdFiEEldLpq4dA2ARjh/0VGgkiex9DWjMFAlw5WKYACgkQGgkiex9D WjPiMRAAn+kaAjVNryGhc2C5B2LqiYq9RYAdvLzc34tgfit9zWm+qJ4WZwLG3L38 XEltBBYwDb4vV29ObdgLsxw/SI6gFK9FuqY0l94ZMcRoA/M7I2h2aOTrPIyhQRlN 0nEb7e1ceh0aaUHMQKRueXCJ28bP38DdFOe+sjZ3aeJL1A4HbhMQfVU5ou8HGti+ DB4oos2I9KSKOjV481TmMKcf9/EfmN1brKEVS13xdKbY+LBx7BfNHP0VQjli62yI a7XVhuntMEekPg8i0MqvBRIPNjpLv9zCNU76FBjJpOkJg1Bv8e7Ae6GRiFuxyBA3 5Hfa6OoBqLvKqDi9kftyD8pwB1+UKjqC/RJIxlFUuQNtwU/LB2Pu+NjpNM1aXIgw OspOh95KwfyjNkl83P/vHjnO5q7ioIYp2Gex3tQjqNjoKPj5YqGnUvbXyIiquL7D Gfjk+geclBvfzB7Z+iMeQcQhcAScoGx7i8tOu9rljdmHIlnLV8vyYwqsc+PrRc3x p/NmzkrwD8kz0FumhIhOlkBk4QlxjSm8vXSu5GvovjdoqUQVJX48lnHeuP2BAhk1 oHmTm4vd8yca8HKxZxjmT8HvQKuG6uudalDPRw9JASzdVf7oS/GgT0AsmJU+V3+x Vl6M63qxt3N+FCelj/4Cxuo3uxZf8ezbdKqn0yIMAUbJ/GZ1Mtk= =NmjB -END PGP SIGNATURE- -BEGIN PGP SIGNED MESSAGE- Hash: SHA512 Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. Signed-off-by: Paul Hardy -BEGIN PGP SIGNATURE- iQIzBAEBCgAdFiEEldLpq4dA2ARjh/0VGgkiex9DWjMFAlw5WGgACgkQGgkiex9D WjNp+xAArO0H3RdWhxylAlR594/JYikvKEe8NiBY3HEwOxEgwUeqLKDEZrGqCVvs ZYzrZ1psNABdxDXCzlT2jq8glrOz+mq+CNLhryuYwDR0T9IBXziW1NVDXaq15M5y sdgvncefUwcXm433ALsNl0Yth4Y+6ptcxLKARZ+BRZUTRyOv9EszqkryPpo3epk9 8RTEVmtNfJZqkDGrfrWOPTxS5B6nN/wliZb7zhxY0dozl4ex58UVJAHhRYER5et6 Im6dpaD2sPS+dE/z5gD40eIclPY473sTmiET99kgbSO7kcoBcCA2RUUR+rjpHLel syle0fxgbMv/MtA+/UgWuuVX/kNqXJBFcu/aITrBj7V8mLBsWGM/oR4LOrlJRVSK PBD+TyvL50k5rNO9CVsuNBHZkeSFFDHFWM7EuZzJpOv1l92USaSluVGUE57LR1cf nlpaXh7tqjGGQRnEJs+05Aw71PkmKfJz6VkEFtbkh9wwwqXJf60kT5QSo50mt489 HWbJkixlzOjTU5OrG8Hy5mmPOYo3hRrAx3mPCMh+sAR5bgIZSJ5bAtTcLHnb3CkC fnuXuSQuan0BzfoRw0kwPpQxOatRXDy3U3WWUsC1AB0BIaCmILYylGv4U/dU+2nT GVnB8CFNPl68bDzPJGYqIUsb8RdLinq5tQBh44eCnRw0o+cmz64= =f//v -END PGP SIGNATURE-
Bug#918384: dgit: typo suggestions in man pages
Paul Hardy writes ("Bug#918384: dgit: typo suggestions in man pages"): > Thank you for such a quick review. Here is another git format-patch > submission that incorporates the feedback from you both, for dgit > version 8.3 this time. I saw no new typos in version 8.3 document > changes. Thanks. I have incorporated this. Right now it is in an ad-hoc branch, because you did not include a Signed-off-by line, and I want to be clear about copyright status. Can you confirm the facts stated in the Developer Certificate of Origin ? (I include a copy of this below.) Also I think I am going to revert or edit a handful of these hunks. The best way to let you comment on that is for me to send patches to do that to this bug for your comment. Regards, Ian. Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Bug#918384: dgit: typo suggestions in man pages
Ian and Sean, Thank you for such a quick review. Here is another git format-patch submission that incorporates the feedback from you both, for dgit version 8.3 this time. I saw no new typos in version 8.3 document changes. I left "a la" as is given that Debian's man command doesn't properly position the grave accent. On Sat, Jan 5, 2019 at 12:18 PM Sean Whitton wrote: > > On Sat 05 Jan 2019 at 09:19am -0800, Paul Hardy wrote: > > > -You should also write appropriate dput configuration, > > +You should also write an appropriate dput configuration, > > Either "appropriate dput configuration" or "an appropriate dgit > configuration file", but not "an appropriate dput configuration", I > think. I used your second choice this time: "an appropriate dgit configuration file". > > @@ -355,7 +355,7 @@ in .git/info/attributes, > > but it is insufficient, > > because it was made by an earlier version of dgit > > and git has since introduced new transforming attributes, > > -modifies the macro to disable the newer transformations. > > +this modifies the macro to disable the newer transformations. > > I think the comma just before your change now needs to be a semicolon. Added a semicolon this time. > > .BR dgit-distro. \fIdistro\fR .clean-mode-newer > > Like .clean-mode, > > -but ignored if the value does not make sense to this version of dgit. > > +but ignored if the value does not make sense for this version of dgit. > > I think this is wrong. Perhaps s/does not make sense to/is unknown to/. Changed to "is unknown to" per your feedback. I thought perhaps the original sounded anthropomorphic but made it only as a suggestion. > > -It should only be used with a care and > > +It should only be used with care and > > "It should be used only with care"* I used your suggestion of "It should be used only with care". All the best, Paul Hardy 0001-typo-suggestions-from-Paul-Hardy.patch.sig Description: PGP signature From a933237851ea55b23df87f869dd96b731a553d3c Mon Sep 17 00:00:00 2001 From: Paul Hardy Date: Wed, 9 Jan 2019 22:35:39 -0800 Subject: [PATCH] typo suggestions from Paul Hardy --- dgit-downstream-dsc.7.pod | 10 +- dgit-maint-debrebase.7.pod | 6 +++--- dgit-maint-native.7.pod| 2 +- dgit-sponsorship.7.pod | 2 +- dgit-user.7.pod| 2 +- dgit.1 | 25 + dgit.7 | 4 ++-- git-debrebase.1.pod| 14 +++--- git-debrebase.5.pod| 22 +++--- 9 files changed, 44 insertions(+), 43 deletions(-) diff --git a/dgit-downstream-dsc.7.pod b/dgit-downstream-dsc.7.pod index fcbce05..ace4fbf 100644 --- a/dgit-downstream-dsc.7.pod +++ b/dgit-downstream-dsc.7.pod @@ -121,8 +121,8 @@ but in most installations this is not needed. If there is no or little distinction between (i) developers who are entitled to upload (push) and (ii) repository administrators, -then a it is sufficient to provide a -git server with a unix account for each user who will pushing, +then it is sufficient to provide a +git server with a unix account for each user who will be pushing, perhaps using ssh restricted commands. =item Debian-format archive (repository) @@ -140,7 +140,7 @@ In this document we will assume you are using B. Setting up reprepro is not covered in this tutorial. Instead, we assume you already have reprepro working. -You should also write appropriate dput configuration, +You should also write an appropriate dput configuration file, since dgit uses dput to upload packages to the archive. This will involve choosing a dput host name. That's probably your distro name, I. @@ -216,7 +216,7 @@ yet a git repository for a particular package. If you always have a git repository for every package in your archive, perhaps because you never use dput/dupload, and always dgit push, -Set C to B. +set C to B. Otherwise, set C to a url prefix - ideally, https. dgit clone will try to fetch @@ -312,7 +312,7 @@ Either don't do that, or set up B. When a user who can push runs dgit, dgit uses ssh to access the git server. -To make ssh restricted command easier, +To make the ssh restricted command easier, and for the benefit of dgit-repos-server, dgit's ssh commands each start with a parseable commentish rune. diff --git a/dgit-maint-debrebase.7.pod b/dgit-maint-debrebase.7.pod index 4996e6a..b91ed16 100644 --- a/dgit-maint-debrebase.7.pod +++ b/dgit-maint-debrebase.7.pod @@ -376,7 +376,7 @@ release: =back Pass I<--stat> just to see the list of changed files, which is useful -to determine whether there are any new or deleted files to may need +to determine whether there are any new or deleted files that may need accounting for in your copyright file. If you obtained a tarball from upstream, you are ready to try a build. @@ -451,7 +451,7 @@ In some cases where you used B since the last upload, it is not possible for dgit to make your history fast-forwarding from the
Bug#918384: dgit: typo suggestions in man pages
On Mon, Jan 7, 2019 at 2:44 AM Ian Jackson wrote: > .. > You are using git for this, right ? Yes. That is how I generated the git format-patch file. If you can give me a couple of days I will look over the 8.3 man page changes as well. Thanks, Paul Hardy
Bug#918384: dgit: typo suggestions in man pages
Paul Hardy writes ("Bug#918384: dgit: typo suggestions in man pages"): > I trust that after you sent this you saw an email I sent beforehand > mentioning that I would be unavailable today. I hope you did not > delay your dgit upload on my account. I was not aware of the poor > timing. No problem. > Did any of the man pages change in your version 8.3 upload from > version 8.1? If not, that will simplify my creating the modified > patch. Some have changed, but I think your rebase / cherry-pick should go forward without difficulty. You are using git for this, right ? Ian. -- Ian JacksonThese opinions are my own. If I emailed you from an address @fyvzl.net or @evade.org.uk, that is a private address which bypasses my fierce spamfilter.
Bug#918384: dgit: typo suggestions in man pages
Ian, On Sun, Jan 6, 2019 at 11:39 AM Ian Jackson wrote: > ... > As for the rest, I agree with Sean's comments. Paul, would you care > to respin the patch ? I'm planning an upload soon today but I can > wait a few hours if that would get thwse changes included. I trust that after you sent this you saw an email I sent beforehand mentioning that I would be unavailable today. I hope you did not delay your dgit upload on my account. I was not aware of the poor timing. Did any of the man pages change in your version 8.3 upload from version 8.1? If not, that will simplify my creating the modified patch. All the best, Paul Hardy
Bug#918384: dgit: typo suggestions in man pages
Hello, On Sun 06 Jan 2019 at 07:39pm GMT, Ian Jackson wrote: >> > > -Whether to setup a merge driver which uses dpkg-mergechangelogs for >> > > +Whether to set up a merge driver which uses dpkg-mergechangelogs for >> > >> > I think this is wrong. AIUI, 'setup' is a noun and 'set up' is a verb. >> >> Right, so it seemed it was being used as a verb; hence "set up". One >> way or another, everybody will know what is meant of course. > > I have a personal tendency to glue words together more than other > people. I think your (Paul's) analysis of this as a verb is correct > (at least for general contemporary usage) and therefore Sean ought to > agree with you that it should be `set up'. I am fine with it being > changed. Whoops, yes, it should be 'set up'. Thanks. -- Sean Whitton
Bug#918384: dgit: typo suggestions in man pages
Paul Hardy writes ("Bug#918384: dgit: typo suggestions in man pages"): > On Sat, Jan 5, 2019 at 12:18 PM Sean Whitton wrote: > > Aren't either acceptable in contemporary English? ('to' is what I would > > expect myself to write) > > I'm accustomed to "different from", but I am not a grammarian. :-) > Whichever you prefer. I am fine with `different to' and apparently write it myself or at least read it without noticing. So I would prefer to retain it. > > > -Whether to setup a merge driver which uses dpkg-mergechangelogs for > > > +Whether to set up a merge driver which uses dpkg-mergechangelogs for > > > > I think this is wrong. AIUI, 'setup' is a noun and 'set up' is a verb. > > Right, so it seemed it was being used as a verb; hence "set up". One > way or another, everybody will know what is meant of course. I have a personal tendency to glue words together more than other people. I think your (Paul's) analysis of this as a verb is correct (at least for general contemporary usage) and therefore Sean ought to agree with you that it should be `set up'. I am fine with it being changed. As for the rest, I agree with Sean's comments. Paul, would you care to respin the patch ? I'm planning an upload soon today but I can wait a few hours if that would get thwse changes included. Regards, Ian. -- Ian JacksonThese opinions are my own. If I emailed you from an address @fyvzl.net or @evade.org.uk, that is a private address which bypasses my fierce spamfilter.
Bug#918384: dgit: typo suggestions in man pages
Sean, On Sat, Jan 5, 2019 at 12:18 PM Sean Whitton wrote: > > [Please use X-debbugs-cc: rather than Cc: when you want a new bug to be > copied to someone else. I had to look up the bug number in order to be > able to reply.] Sorry, wasn't thinking. I added your name at the last moment. > Hello Paul, > > Thank you for your interest. Here is a review of the patch. > > On Sat 05 Jan 2019 at 09:19am -0800, Paul Hardy wrote: > > > dgit clone needs to be told the source package name > > -(which might be different to the binary package name, > > +(which might be different from the binary package name, > > Aren't either acceptable in contemporary English? ('to' is what I would > expect myself to write) I'm accustomed to "different from", but I am not a grammarian. :-) Whichever you prefer. > > @@ -355,7 +355,7 @@ in .git/info/attributes, > > but it is insufficient, > > because it was made by an earlier version of dgit > > and git has since introduced new transforming attributes, > > -modifies the macro to disable the newer transformations. > > +this modifies the macro to disable the newer transformations. > > I think the comma just before your change now needs to be a semicolon. Yes, it does. I missed that. > > -the latter unless the former exists on PATH.) > > +the latter unless the former exists in PATH.) > > This is wrong. "in PATH" suggests actually present in the string PATH; > "on PATH" means in one of the directories specified by PATH, AFAIK. Okay. > > -Whether to setup a merge driver which uses dpkg-mergechangelogs for > > +Whether to set up a merge driver which uses dpkg-mergechangelogs for > > I think this is wrong. AIUI, 'setup' is a noun and 'set up' is a verb. Right, so it seemed it was being used as a verb; hence "set up". One way or another, everybody will know what is meant of course. All the best, Paul Hardy
Bug#918384: dgit: typo suggestions in man pages
[Please use X-debbugs-cc: rather than Cc: when you want a new bug to be copied to someone else. I had to look up the bug number in order to be able to reply.] Hello Paul, Thank you for your interest. Here is a review of the patch. On Sat 05 Jan 2019 at 09:19am -0800, Paul Hardy wrote: > In git-debrebase.5.pod, after "reified" I added " [re-quiltified?]" as > a guess of what you meant. You'll want to change that accordingly. I think we just meant 'reified' ... I'm afraid no synonyms spring to mind. > -You should also write appropriate dput configuration, > +You should also write an appropriate dput configuration, Either "appropriate dput configuration" or "an appropriate dgit configuration file", but not "an appropriate dput configuration", I think. > dgit clone needs to be told the source package name > -(which might be different to the binary package name, > +(which might be different from the binary package name, Aren't either acceptable in contemporary English? ('to' is what I would expect myself to write) > -different to or even disjoint from dgit's view. > +different from or even disjoint from dgit's view. Similarly. > the .dsc. It then pushes the HEAD to the suite's dgit-repos branch, > adjusts the .changes to include any .origs which the archive lacks > -and exclude .origs which the archive has > +and excludes .origs which the archive has This is wrong -- it should agree with the 'include' in the previous line. > @@ -355,7 +355,7 @@ in .git/info/attributes, > but it is insufficient, > because it was made by an earlier version of dgit > and git has since introduced new transforming attributes, > -modifies the macro to disable the newer transformations. > +this modifies the macro to disable the newer transformations. I think the comma just before your change now needs to be a semicolon. > -the latter unless the former exists on PATH.) > +the latter unless the former exists in PATH.) This is wrong. "in PATH" suggests actually present in the string PATH; "on PATH" means in one of the directories specified by PATH, AFAIK. > .BR dgit-distro. \fIdistro\fR .clean-mode-newer > Like .clean-mode, > -but ignored if the value does not make sense to this version of dgit. > +but ignored if the value does not make sense for this version of dgit. I think this is wrong. Perhaps s/does not make sense to/is unknown to/. > -Whether to setup a merge driver which uses dpkg-mergechangelogs for > +Whether to set up a merge driver which uses dpkg-mergechangelogs for I think this is wrong. AIUI, 'setup' is a noun and 'set up' is a verb. > -It should only be used with a care and > +It should only be used with care and "It should be used only with care"* :) > @@ -135,7 +135,7 @@ See L. > >* Maintainer's HEAD was here while they were editing, >before they said they were done, at which point their > - tools made -/- (and maybe %) to convert to > + tools made -/- (and maybe %) convert to >the fast-forwarding interchange branch. This is wrong. It changes the meaning to something other than what was intended. Otherwise, LGTM. -- Sean Whitton signature.asc Description: PGP signature
Bug#918384: dgit: typo suggestions in man pages
Package: dgit Version: 8.1 Severity: wishlist Tags: patch Hello, Attached are some typo suggestions as a git format-patch file. One suggestion you may want to decline, in dgit.7: "\`a la" instead of "a la"; nroff/man on Debian does not form the grave accent correctly; not sure why. I did not add periods to any Latin abbreviations ("eg" != "e.g.", "et al" != "et al.", and so on). I think I only made one other typographical change, in git-debrebase.1.pod: C<..>. ==> "C<..>". so the ".." would stand out better. In git-debrebase.5.pod, after "reified" I added " [re-quiltified?]" as a guess of what you meant. You'll want to change that accordingly. Thanks, Paul Hardy 0001-typo-suggestions-from-Paul-Hardy.patch.sig Description: PGP signature From a90cee7d6b2a89ced11baf0755299cb8b27108cc Mon Sep 17 00:00:00 2001 From: Paul Hardy Date: Sat, 5 Jan 2019 08:42:10 -0800 Subject: [PATCH] typo suggestions from Paul Hardy --- dgit-downstream-dsc.7.pod | 10 +- dgit-maint-debrebase.7.pod | 6 +++--- dgit-maint-native.7.pod| 2 +- dgit-sponsorship.7.pod | 2 +- dgit-user.7.pod| 4 ++-- dgit.1 | 25 + dgit.7 | 6 +++--- git-debrebase.1.pod| 14 +++--- git-debrebase.5.pod| 26 +- 9 files changed, 48 insertions(+), 47 deletions(-) diff --git a/dgit-downstream-dsc.7.pod b/dgit-downstream-dsc.7.pod index fcbce05..78c18f7 100644 --- a/dgit-downstream-dsc.7.pod +++ b/dgit-downstream-dsc.7.pod @@ -121,8 +121,8 @@ but in most installations this is not needed. If there is no or little distinction between (i) developers who are entitled to upload (push) and (ii) repository administrators, -then a it is sufficient to provide a -git server with a unix account for each user who will pushing, +then it is sufficient to provide a +git server with a unix account for each user who will be pushing, perhaps using ssh restricted commands. =item Debian-format archive (repository) @@ -140,7 +140,7 @@ In this document we will assume you are using B. Setting up reprepro is not covered in this tutorial. Instead, we assume you already have reprepro working. -You should also write appropriate dput configuration, +You should also write an appropriate dput configuration, since dgit uses dput to upload packages to the archive. This will involve choosing a dput host name. That's probably your distro name, I. @@ -216,7 +216,7 @@ yet a git repository for a particular package. If you always have a git repository for every package in your archive, perhaps because you never use dput/dupload, and always dgit push, -Set C to B. +set C to B. Otherwise, set C to a url prefix - ideally, https. dgit clone will try to fetch @@ -312,7 +312,7 @@ Either don't do that, or set up B. When a user who can push runs dgit, dgit uses ssh to access the git server. -To make ssh restricted command easier, +To make the ssh restricted command easier, and for the benefit of dgit-repos-server, dgit's ssh commands each start with a parseable commentish rune. diff --git a/dgit-maint-debrebase.7.pod b/dgit-maint-debrebase.7.pod index f167928..8a182dd 100644 --- a/dgit-maint-debrebase.7.pod +++ b/dgit-maint-debrebase.7.pod @@ -376,7 +376,7 @@ release: =back Pass I<--stat> just to see the list of changed files, which is useful -to determine whether there are any new or deleted files to may need +to determine whether there are any new or deleted files that may need accounting for in your copyright file. If you obtained a tarball from upstream, you are ready to try a build. @@ -451,7 +451,7 @@ In some cases where you used B since the last upload, it is not possible for dgit to make your history fast-forwarding from the history on B. In such cases you will have to pass I<--overwrite> to dgit. git-debrebase will normally -tell you if this is will be needed. +tell you if this will be needed. Right before uploading, if you did not just already do so, you might want to have git-debrebase(1) shuffle your branch such that the Debian @@ -545,7 +545,7 @@ In the simplest case, =back -If that fails, because your branch and the NMUers work represent +If that fails, because your branch and the NMUers' work represent divergent branches of development, you have a number of options. Here we describe the two simplest. diff --git a/dgit-maint-native.7.pod b/dgit-maint-native.7.pod index ac57728..792be10 100644 --- a/dgit-maint-native.7.pod +++ b/dgit-maint-native.7.pod @@ -85,7 +85,7 @@ is fast forward from the dgit archive view. Alternatively, if this was the first ever dgit push of the package, you can avoid this merge commit by -passing C<--deliberately-not-fast-forward>. +passing C<--deliberately-not-fast-forward> instead of C<--overwrite>. This avoids introducing a new origin commit into your git history. diff --git a/dgit-sponsorship.7.pod b/dgit-sponsorship.7.pod index