From 557c031ac723677bb9e6bd3deee6dc6cd29cb2ca Mon Sep 17 00:00:00 2001 From: avinab-neogy Date: Fri, 13 Jun 2025 11:21:28 +0530 Subject: [PATCH 1/3] Update patch naming documentation and fix markdown lint errors (closes #220) --- docs/tutorials/patch_update.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/patch_update.md b/docs/tutorials/patch_update.md index 1a75b5c5d..63d66cc84 100644 --- a/docs/tutorials/patch_update.md +++ b/docs/tutorials/patch_update.md @@ -14,14 +14,24 @@ this first. Go to the source directory and use `svn diff` to create a patch. +**Use a descriptive patch name with the bug number and a short description, +rather than a generic name like `patch.diff`.** + ```bash cd $TOP_SRCDIR -svn diff > $PATCHDIR/patch.diff +svn diff > $PATCHDIR/16629-infinite-recursion.diff ``` +> e.g. `16629-infinite-recursion.diff` - This name follows the convention: +bug number (16629), short description (infinite-recursion), and .diff extension, + making patches easy to identify and review. + The patch file will be saved in the directory specified by the PATCHDIR environment variable that is defined when the codespace starts ```bash -echo $PATCHDIR/patch.diff +ls $PATCHDIR ``` + +lists all patch files in your patch directory, allowing you to easily +see and verify the patch files you have created. From ce6a53346ff1d15fc9981b9dcda764539289220c Mon Sep 17 00:00:00 2001 From: avinab-neogy Date: Fri, 13 Jun 2025 11:31:25 +0530 Subject: [PATCH 2/3] Fix markdown lint errors --- .github/workflows/build-mkdocs-website.yml | 2 +- INIT | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) delete mode 100644 INIT diff --git a/.github/workflows/build-mkdocs-website.yml b/.github/workflows/build-mkdocs-website.yml index a35f511bb..5e4e0ce97 100644 --- a/.github/workflows/build-mkdocs-website.yml +++ b/.github/workflows/build-mkdocs-website.yml @@ -12,7 +12,7 @@ on: permissions: contents: write - + jobs: build-and-deploy: if: | diff --git a/INIT b/INIT deleted file mode 100644 index bffd9aad0..000000000 --- a/INIT +++ /dev/null @@ -1,3 +0,0 @@ -This file is used as a marker to indicate when a codespace is first opened. - -See `scripts/welcome_message.sh` for use. From 7fc24fbae3c1b39de0f3da9c1bddf0f685ed1af1 Mon Sep 17 00:00:00 2001 From: Heather Turner Date: Fri, 13 Jun 2025 08:20:46 +0100 Subject: [PATCH 3/3] minor edits to patch tutorial --- docs/tutorials/patch_update.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tutorials/patch_update.md b/docs/tutorials/patch_update.md index 63d66cc84..614d90429 100644 --- a/docs/tutorials/patch_update.md +++ b/docs/tutorials/patch_update.md @@ -22,12 +22,12 @@ cd $TOP_SRCDIR svn diff > $PATCHDIR/16629-infinite-recursion.diff ``` -> e.g. `16629-infinite-recursion.diff` - This name follows the convention: -bug number (16629), short description (infinite-recursion), and .diff extension, - making patches easy to identify and review. +The example above uses `16629-infinite-recursion.diff` - this name follows the +convention: bug number (16629), short description (infinite-recursion), and +`.diff` extension, making patches easy to identify and review. The patch file will be saved in the directory specified by the PATCHDIR -environment variable that is defined when the codespace starts +environment variable that is defined when the codespace starts. ```bash ls $PATCHDIR