Skip to content
This repository was archived by the owner on Feb 13, 2026. It is now read-only.

Write initial patchfiles documentation#87

Merged
rkratky merged 8 commits into
canonical:2.0-previewfrom
tsimonq2:tsimonq2/writing-patches
Jun 14, 2025
Merged

Write initial patchfiles documentation#87
rkratky merged 8 commits into
canonical:2.0-previewfrom
tsimonq2:tsimonq2/writing-patches

Conversation

@tsimonq2

Copy link
Copy Markdown
Contributor

A few gems in here, plus the relevant links to Debian Policy. Feel free to make minor modifications before merging if needed.

@eeickmeyer

eeickmeyer commented Jan 16, 2025

Copy link
Copy Markdown

Just of note, if someone wants to make it easy on themselves:

git-cola is really useful when creating patchfiles in this case. One can simply make a branch or otherwise mock a git commit then go to "View DAG" which brings up the graph, then right-click on the commit, and click on "Create Patch" which will then create a DEP-3 formatted patch in a "Patches" directory in the root of the git repo beginning with "0001-". Makes it then easy to add to debian/patches and put into the proper sequence to add to series.

The more you know! 🌈 ⭐

Comment thread docs/how-to/write-patchfiles.rst Outdated
@dviererbe

Copy link
Copy Markdown
Collaborator

Just of note, if someone wants to make it easy on themselves:

git-cola is really useful when creating patchfiles in this case. One can simply make a branch or otherwise mock a git commit then go to "View DAG" which brings up the graph, then right-click on the commit, and click on "Create Patch" which will then create a DEP-3 formatted patch in a "Patches" directory in the root of the git repo beginning with "0001-". Makes it then easy to add to debian/patches and put into the proper sequence to add to series.

The more you know! 🌈 ⭐

praise: Good to know, this a really nice tool :)
note: I think this does not fit into the topic of managing patch files.
thought: But we could create a reference article with a list of tools (relevant to the packaging topic) that exists.

@dviererbe dviererbe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: I merged my work on documenting patch management into this PR branch.

I moved a lot of the work by @tsimonq2 into an explanation article, which is linked at the top of the how-to.

todo: @rkratky This PR is ready for review by you.

@dviererbe dviererbe requested a review from rkratky February 7, 2025 12:22
@dviererbe

Copy link
Copy Markdown
Collaborator

issue: There are SRU docs in the diff???

dviererbe and others added 5 commits February 7, 2025 14:42
Signed-off-by: Dominik Viererbe <dominik.viererbe@canonical.com>
This commit semanticly combines the work I have done 7 months ago in the
branch 'how-to/patch-management' and the new contributions by tsimonq2
on documenting patch managment on Ubuntu source packages.

This commit also adds new work on this topic.
@dviererbe dviererbe force-pushed the tsimonq2/writing-patches branch from ebf64c2 to d65d176 Compare February 7, 2025 12:56
@dviererbe

Copy link
Copy Markdown
Collaborator

issue: There are SRU docs in the diff???

Solved it:

  • I rebased how-to/patch-management branch onto preview/2.0
  • I rebased tsimonq2 branch onto preview/2.0
  • then I merged them

@dviererbe

Copy link
Copy Markdown
Collaborator

note: the linkcheck failures can be ignored

(reference/architectures: line   66) broken    https://canonical.com/blog/statement-on-32-bit-i386-packages-for-ubuntu-19-10-and-20-04-lts - 500 Server Error:  for url: https://canonical.com/blog/statement-on-32-bit-i386-packages-for-ubuntu-19-10-and-20-04-lts
(reference/glossary: line  681) broken    https://www.gnu.org - HTTPSConnectionPool(host='www.gnu.org', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f2f96b8a140>: Failed to establish a new connection: [Errno 101] Network is unreachable'))
(explanation/package-model: line   80) broken    https://www.gnu.org/software/bash/ - HTTPSConnectionPool(host='www.gnu.org', port=443): Max retries exceeded with url: /software/bash/ (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f2f969e2470>: Failed to establish a new connection: [Errno 101] Network is unreachable'))

The links all work

@dviererbe dviererbe added documentation Improvements or additions to documentation community Community contribution labels Feb 7, 2025
@dviererbe

Copy link
Copy Markdown
Collaborator

note: This how-to does not show how to easily generate a patchfile with git-ubuntu. I created this task as #94 – marked as a good first issue.

Comment thread docs/how-to/patch-management.rst Outdated
if ! grep --silent --fixed-strings '3.0 (quilt)' \
"${SourcePackageRoot}/debian/source/format"
then
echo -e '\033[1;33mWARNING\033[0m: This source package does \033[1mNOT\033[0m use the 3.0 (quilt) format. The corresponding defaults defined in ~/.quiltrc do not get applied.'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: thanks for catching the typo

Co-authored-by: Dominik Viererbe <github@dviererbe.de>
@rkratky rkratky merged commit 33516a6 into canonical:2.0-preview Jun 14, 2025
1 of 2 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

community Community contribution documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write reference "DEP 3 – Patch file headers" Write explanation "Patches" Write how-to "Patch management"

4 participants