diff options
| author | Maxim Cournoyer <maxim@guixotic.coop> | 2026-06-21 10:10:47 +0900 |
|---|---|---|
| committer | Maxim Cournoyer <maxim@guixotic.coop> | 2026-06-21 10:21:37 +0900 |
| commit | 3210143e852cf940c18a7043f7cb778eb8539efc (patch) | |
| tree | 018a191d481cf090ccb16e784eebf6e3d87a6a13 | |
| parent | cfd388999192e3e3d2a920b7ef5b95ece83d0e64 (diff) | |
doc: Remove Debbugs-related documentation.
We've been using Codeberg for more than a year now. Also delete email-flow
related config files.
* doc/contributing.texi (Tracking Bugs and Changes)
<Debbugs User Interfaces>: Delete subsection.
* .patman: Delete file.
* .mumi/config: Likewise.
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | .mumi/config | 3 | ||||
| -rw-r--r-- | .patman | 11 | ||||
| -rw-r--r-- | doc/contributing.texi | 227 | ||||
| -rw-r--r-- | doc/guix.texi | 4 |
5 files changed, 2 insertions, 244 deletions
diff --git a/.gitignore b/.gitignore index 8779222df0c..c1f1a0a13c9 100644 --- a/.gitignore +++ b/.gitignore | |||
| @@ -160,4 +160,3 @@ tmp | |||
| 160 | /gnu/packages/aux-files/guile-guile-launcher.o | 160 | /gnu/packages/aux-files/guile-guile-launcher.o |
| 161 | /guile | 161 | /guile |
| 162 | .DS_Store | 162 | .DS_Store |
| 163 | .mumi/current-issue | ||
diff --git a/.mumi/config b/.mumi/config deleted file mode 100644 index 6823e1c425c..00000000000 --- a/.mumi/config +++ /dev/null | |||
| @@ -1,3 +0,0 @@ | |||
| 1 | ((debbugs-host . "debbugs.gnu.org") | ||
| 2 | (patch-email-address . "guix-patches@gnu.org") | ||
| 3 | (mumi-host . "issues.guix.gnu.org")) | ||
diff --git a/.patman b/.patman deleted file mode 100644 index efc42144a2a..00000000000 --- a/.patman +++ /dev/null | |||
| @@ -1,11 +0,0 @@ | |||
| 1 | # This config file allows for Patchwork integration with | ||
| 2 | # https://patches.guix-patches.cbaines.net/. | ||
| 3 | |||
| 4 | [settings] | ||
| 5 | project: guix-patches | ||
| 6 | patchwork_url: https://patches.guix-patches.cbaines.net | ||
| 7 | add_signoff: False | ||
| 8 | # TODO: enable check_patch | ||
| 9 | check_patch: False | ||
| 10 | ignore_bad_tags: True | ||
| 11 | keep_change_id: True | ||
diff --git a/doc/contributing.texi b/doc/contributing.texi index dc9a3fe4c99..95ba08c508c 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi | |||
| @@ -2262,28 +2262,16 @@ patch submissions and topic branches. | |||
| 2262 | @menu | 2262 | @menu |
| 2263 | * The Issue Tracker:: The official bug and patch tracker. | 2263 | * The Issue Tracker:: The official bug and patch tracker. |
| 2264 | * Managing Patches and Branches:: How changes to Guix are managed. | 2264 | * Managing Patches and Branches:: How changes to Guix are managed. |
| 2265 | * Debbugs User Interfaces:: Ways to interact with Debbugs. | ||
| 2266 | * Cuirass Build Notifications:: Be alerted of any breakage via RSS feeds. | 2265 | * Cuirass Build Notifications:: Be alerted of any breakage via RSS feeds. |
| 2267 | @end menu | 2266 | @end menu |
| 2268 | 2267 | ||
| 2269 | @node The Issue Tracker | 2268 | @node The Issue Tracker |
| 2270 | @subsection The Issue Tracker | 2269 | @subsection The Issue Tracker |
| 2271 | 2270 | ||
| 2272 | @cindex email workflow, deprecated | ||
| 2273 | @cindex issue tracker, for the email workflow | ||
| 2274 | @cindex Debbugs, issue tracking system | ||
| 2275 | Bug reports (@dfn{issues}) and patch submissions (@dfn{pull requests}) | 2271 | Bug reports (@dfn{issues}) and patch submissions (@dfn{pull requests}) |
| 2276 | are currently tracked at the @uref{https://codeberg.org/guix/guix, | 2272 | are currently tracked at the @uref{https://codeberg.org/guix/guix, |
| 2277 | project's home at Codeberg}. | 2273 | project's home at Codeberg}. |
| 2278 | 2274 | ||
| 2279 | Before January 1st, 2026, bug reports and patches were tracked using the | ||
| 2280 | Debbugs instance at @uref{https://bugs.gnu.org}, which can also be | ||
| 2281 | browsed at @uref{https://issues.guix.gnu.org}. This has been | ||
| 2282 | discontinued and Codeberg is now the sole option to report new bugs and | ||
| 2283 | propose new changes@footnote{Check out | ||
| 2284 | @uref{https://codeberg.org/guix/guix-consensus-documents/src/branch/main/002-codeberg.md, | ||
| 2285 | Guix Consensus Document 002} for details on this decision.}. | ||
| 2286 | |||
| 2287 | @node Managing Patches and Branches | 2275 | @node Managing Patches and Branches |
| 2288 | @subsection Managing Patches and Branches | 2276 | @subsection Managing Patches and Branches |
| 2289 | @cindex branching strategy | 2277 | @cindex branching strategy |
| @@ -2389,203 +2377,6 @@ that are ready to be merged. When the branch is no longer a work in | |||
| 2389 | progress, it should be renamed, with the @samp{wip-} prefix removed, and | 2377 | progress, it should be renamed, with the @samp{wip-} prefix removed, and |
| 2390 | only then should the merge requests be created, as documented earlier. | 2378 | only then should the merge requests be created, as documented earlier. |
| 2391 | 2379 | ||
| 2392 | @node Debbugs User Interfaces | ||
| 2393 | @subsection Debbugs User Interfaces | ||
| 2394 | |||
| 2395 | @quotation Warning | ||
| 2396 | This section is about bug reports and patches sent by email to | ||
| 2397 | @uref{https://issues.guix.gnu.org, Debbugs}, which is discontinued. | ||
| 2398 | Since January 1st, 2026, bug reports and patches are submitted as issues | ||
| 2399 | and pull requests on @uref{https://codeberg.org/guix/guix, Codeberg}. | ||
| 2400 | @xref{Submitting Patches}, for more info. | ||
| 2401 | @end quotation | ||
| 2402 | |||
| 2403 | @subsubsection Web interface | ||
| 2404 | |||
| 2405 | @cindex mumi, web interface for issues | ||
| 2406 | A web interface (actually @emph{two} web interfaces!) are available to | ||
| 2407 | browse issues: | ||
| 2408 | |||
| 2409 | @itemize | ||
| 2410 | @item | ||
| 2411 | @url{https://issues.guix.gnu.org} provides a pleasant interface powered | ||
| 2412 | by mumi@footnote{Mumi is a nice piece of software written in Guile, and | ||
| 2413 | you can help! See | ||
| 2414 | @url{https://codeberg.org/guix/mumi}.} to browse bug | ||
| 2415 | reports and patches, and to participate in discussions; mumi also has a | ||
| 2416 | command-line interface as we will see below; | ||
| 2417 | @item | ||
| 2418 | @url{https://bugs.gnu.org/guix} lists bug reports; | ||
| 2419 | @item | ||
| 2420 | @url{https://bugs.gnu.org/guix-patches} lists patch submissions. | ||
| 2421 | @end itemize | ||
| 2422 | |||
| 2423 | To view discussions related to issue number @var{n}, go to | ||
| 2424 | @indicateurl{https://issues.guix.gnu.org/@var{n}} or | ||
| 2425 | @indicateurl{https://bugs.gnu.org/@var{n}}. | ||
| 2426 | |||
| 2427 | @subsubsection Command-Line Interface | ||
| 2428 | |||
| 2429 | @cindex mumi command-line interface | ||
| 2430 | @cindex mumi am | ||
| 2431 | @cindex mumi compose | ||
| 2432 | @cindex mumi send-email | ||
| 2433 | @cindex mumi www | ||
| 2434 | Mumi also comes with a command-line interface that can be used to search | ||
| 2435 | existing issues, open new issues, compose replies, apply and send | ||
| 2436 | patches. You do not need to use Emacs to use the mumi command-line | ||
| 2437 | client. You interact with it only on the command-line. | ||
| 2438 | |||
| 2439 | To use the mumi command-line interface, navigate to a local clone of the | ||
| 2440 | Guix git repository, and drop into a shell with mumi, git and | ||
| 2441 | git:send-email installed. | ||
| 2442 | |||
| 2443 | @example | ||
| 2444 | $ cd guix | ||
| 2445 | ~/guix$ guix shell mumi git git:send-email | ||
| 2446 | @end example | ||
| 2447 | |||
| 2448 | To search for issues, say all open issues about "zig", run | ||
| 2449 | |||
| 2450 | @example | ||
| 2451 | ~/guix [env]$ mumi search zig is:open | ||
| 2452 | |||
| 2453 | #60889 Add zig-build-system | ||
| 2454 | opened on 17 Jan 17:37 Z by Ekaitz Zarraga | ||
| 2455 | #61036 [PATCH 0/3] Update zig to 0.10.1 | ||
| 2456 | opened on 24 Jan 09:42 Z by Efraim Flashner | ||
| 2457 | #39136 [PATCH] gnu: services: Add endlessh. | ||
| 2458 | opened on 14 Jan 2020 21:21 by Nicol? Balzarotti | ||
| 2459 | #60424 [PATCH] gnu: Add python-online-judge-tools | ||
| 2460 | opened on 30 Dec 2022 07:03 by gemmaro | ||
| 2461 | #45601 [PATCH 0/6] vlang 0.2 update | ||
| 2462 | opened on 1 Jan 2021 19:23 by Ryan Prior | ||
| 2463 | @end example | ||
| 2464 | |||
| 2465 | Pick an issue and make it the "current" issue. | ||
| 2466 | |||
| 2467 | @example | ||
| 2468 | ~/guix [env]$ mumi current 61036 | ||
| 2469 | |||
| 2470 | #61036 [PATCH 0/3] Update zig to 0.10.1 | ||
| 2471 | opened on 24 Jan 09:42 Z by Efraim Flashner | ||
| 2472 | @end example | ||
| 2473 | |||
| 2474 | Once an issue is the current issue, you can open the issue in a web | ||
| 2475 | browser, compose replies, apply patches, send patches, etc. with short | ||
| 2476 | succinct commands. | ||
| 2477 | |||
| 2478 | Open the issue in your web browser using | ||
| 2479 | |||
| 2480 | @example | ||
| 2481 | ~/guix [env]$ mumi www | ||
| 2482 | @end example | ||
| 2483 | |||
| 2484 | Compose a reply using | ||
| 2485 | |||
| 2486 | @example | ||
| 2487 | ~/guix [env]$ mumi compose | ||
| 2488 | @end example | ||
| 2489 | |||
| 2490 | Compose a reply and close the issue using | ||
| 2491 | |||
| 2492 | @example | ||
| 2493 | ~/guix [env]$ mumi compose --close | ||
| 2494 | @end example | ||
| 2495 | |||
| 2496 | @command{mumi compose} opens your mail client by passing @samp{mailto:} | ||
| 2497 | URIs to @command{xdg-open}. So, you need to have @command{xdg-open} set | ||
| 2498 | up to open your mail client correctly. | ||
| 2499 | |||
| 2500 | Apply the latest patchset from the issue using | ||
| 2501 | |||
| 2502 | @example | ||
| 2503 | ~/guix [env]$ mumi am | ||
| 2504 | @end example | ||
| 2505 | |||
| 2506 | You may also apply a patchset of a specific version (say, v3) using | ||
| 2507 | |||
| 2508 | @example | ||
| 2509 | ~/guix [env]$ mumi am v3 | ||
| 2510 | @end example | ||
| 2511 | |||
| 2512 | Or, you may apply a patch from a specific e-mail message. For example, | ||
| 2513 | to apply the patch from the 4th message (message index starts from 0), | ||
| 2514 | run | ||
| 2515 | |||
| 2516 | @example | ||
| 2517 | ~/guix [env]$ mumi am @@4 | ||
| 2518 | @end example | ||
| 2519 | |||
| 2520 | @command{mumi am} is a wrapper around @command{git am}. You can pass | ||
| 2521 | @command{git am} arguments to it after a @samp{--}. For example, to add | ||
| 2522 | a Signed-off-by trailer, run | ||
| 2523 | |||
| 2524 | @example | ||
| 2525 | ~/guix [env]$ mumi am -- -s | ||
| 2526 | @end example | ||
| 2527 | |||
| 2528 | Create and send patches to the issue using | ||
| 2529 | |||
| 2530 | @example | ||
| 2531 | ~/guix [env]$ git format-patch origin/master | ||
| 2532 | ~/guix [env]$ mumi send-email foo.patch bar.patch | ||
| 2533 | @end example | ||
| 2534 | |||
| 2535 | Note that you do not have to pass in @samp{--to} or @samp{--cc} | ||
| 2536 | arguments to @command{git format-patch}. @command{mumi send-email} will | ||
| 2537 | put them in correctly when sending the patches. | ||
| 2538 | |||
| 2539 | To open a new issue, run | ||
| 2540 | |||
| 2541 | @example | ||
| 2542 | ~/guix [env]$ mumi new | ||
| 2543 | @end example | ||
| 2544 | |||
| 2545 | and send an email (using @command{mumi compose}) or patches (using | ||
| 2546 | @command{mumi send-email}). | ||
| 2547 | |||
| 2548 | @command{mumi send-email} is really a wrapper around @command{git | ||
| 2549 | send-email} that automates away all the nitty-gritty of sending patches. | ||
| 2550 | It uses the current issue state to automatically figure out the correct | ||
| 2551 | @samp{To} address to send to, other participants to @samp{Cc}, headers | ||
| 2552 | to add, etc. | ||
| 2553 | |||
| 2554 | Also note that, unlike @command{git send-email}, @command{mumi | ||
| 2555 | send-email} works perfectly well with single and multiple patches alike. | ||
| 2556 | It automates away the debbugs dance of sending the first patch, waiting | ||
| 2557 | for a response from debbugs and sending the remaining patches. It does | ||
| 2558 | so by sending the first patch, polling the server for a response, and | ||
| 2559 | then sending the remaining patches. This polling can unfortunately take | ||
| 2560 | a few minutes. So, please be patient. | ||
| 2561 | |||
| 2562 | @subsubsection Emacs Interface | ||
| 2563 | |||
| 2564 | If you use Emacs, you may find it more convenient to interact with | ||
| 2565 | issues using @file{debbugs.el}, which you can install with: | ||
| 2566 | |||
| 2567 | @example | ||
| 2568 | guix install emacs-debbugs | ||
| 2569 | @end example | ||
| 2570 | |||
| 2571 | For example, to list all open issues on @code{guix-patches}, hit: | ||
| 2572 | |||
| 2573 | @example | ||
| 2574 | @kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y | ||
| 2575 | @end example | ||
| 2576 | |||
| 2577 | For a more convenient (shorter) way to access both the bugs and patches | ||
| 2578 | submissions, you may want to configure the | ||
| 2579 | @code{debbugs-gnu-default-packages} and | ||
| 2580 | @code{debbugs-gnu-default-severities} Emacs variables (@pxref{Minor | ||
| 2581 | Mode,,, debbugs-ug, The Debbugs User Guide}). | ||
| 2582 | |||
| 2583 | To search for bugs, @samp{@kbd{M-x} debbugs-gnu-guix-search} can be | ||
| 2584 | used. | ||
| 2585 | |||
| 2586 | @xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on | ||
| 2587 | this nifty tool! | ||
| 2588 | |||
| 2589 | @node Cuirass Build Notifications | 2380 | @node Cuirass Build Notifications |
| 2590 | @subsection Cuirass Build Notifications | 2381 | @subsection Cuirass Build Notifications |
| 2591 | 2382 | ||
| @@ -2682,24 +2473,6 @@ members: | |||
| 2682 | @dots{} | 2473 | @dots{} |
| 2683 | @end example | 2474 | @end example |
| 2684 | 2475 | ||
| 2685 | @cindex mentoring | ||
| 2686 | You can run the following command to have the Mentors team put in | ||
| 2687 | CC of a patch series: | ||
| 2688 | |||
| 2689 | @example | ||
| 2690 | $ git send-email --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org \ | ||
| 2691 | --header-cmd='etc/teams.scm cc-mentors-header-cmd' *.patch | ||
| 2692 | @end example | ||
| 2693 | |||
| 2694 | The appropriate team or teams can also be inferred from the modified | ||
| 2695 | files. For instance, if you want to send the two latest commits of the | ||
| 2696 | current Git repository to review, you can run: | ||
| 2697 | |||
| 2698 | @example | ||
| 2699 | $ guix shell -D guix | ||
| 2700 | [env]$ git send-email --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org -2 | ||
| 2701 | @end example | ||
| 2702 | |||
| 2703 | @cindex teams, on Codeberg | 2476 | @cindex teams, on Codeberg |
| 2704 | To generate a @file{CODEOWNERS} file, which Forgejo---the software | 2477 | To generate a @file{CODEOWNERS} file, which Forgejo---the software |
| 2705 | behind Codeberg---uses to determine which team or person should review | 2478 | behind Codeberg---uses to determine which team or person should review |
diff --git a/doc/guix.texi b/doc/guix.texi index f384dfb2539..f1e5c78a0b6 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -307,7 +307,7 @@ Package Management | |||
| 307 | Substitutes | 307 | Substitutes |
| 308 | 308 | ||
| 309 | * Official Substitute Servers:: One particular source of substitutes. | 309 | * Official Substitute Servers:: One particular source of substitutes. |
| 310 | * Volunteer Run Mirrors:: Additional, regional sources of substitutes. | 310 | * Volunteer Run Mirrors:: Additional, regional sources of substitutes. |
| 311 | * Substitute Server Authorization:: How to enable or disable substitutes. | 311 | * Substitute Server Authorization:: How to enable or disable substitutes. |
| 312 | * Getting Substitutes from Other Servers:: Substitute diversity. | 312 | * Getting Substitutes from Other Servers:: Substitute diversity. |
| 313 | * Substitute Authentication:: How Guix verifies substitutes. | 313 | * Substitute Authentication:: How Guix verifies substitutes. |
| @@ -3993,7 +3993,7 @@ also result from derivation builds, can be available as substitutes. | |||
| 3993 | 3993 | ||
| 3994 | @menu | 3994 | @menu |
| 3995 | * Official Substitute Servers:: One particular source of substitutes. | 3995 | * Official Substitute Servers:: One particular source of substitutes. |
| 3996 | * Volunteer Run Mirrors:: Additional, regional sources of substitutes. | 3996 | * Volunteer Run Mirrors:: Additional, regional sources of substitutes. |
| 3997 | * Substitute Server Authorization:: How to enable or disable substitutes. | 3997 | * Substitute Server Authorization:: How to enable or disable substitutes. |
| 3998 | * Getting Substitutes from Other Servers:: Substitute diversity. | 3998 | * Getting Substitutes from Other Servers:: Substitute diversity. |
| 3999 | * Substitute Authentication:: How Guix verifies substitutes. | 3999 | * Substitute Authentication:: How Guix verifies substitutes. |
