Skip to content

Commit 557c031

Browse files
committed
Update patch naming documentation and fix markdown lint errors (closes #220)
1 parent 4e99cf0 commit 557c031

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/tutorials/patch_update.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,24 @@ this first.
1414

1515
Go to the source directory and use `svn diff` to create a patch.
1616

17+
**Use a descriptive patch name with the bug number and a short description,
18+
rather than a generic name like `patch.diff`.**
19+
1720
```bash
1821
cd $TOP_SRCDIR
19-
svn diff > $PATCHDIR/patch.diff
22+
svn diff > $PATCHDIR/16629-infinite-recursion.diff
2023
```
2124

25+
> e.g. `16629-infinite-recursion.diff` - This name follows the convention:
26+
bug number (16629), short description (infinite-recursion), and .diff extension,
27+
making patches easy to identify and review.
28+
2229
The patch file will be saved in the directory specified by the PATCHDIR
2330
environment variable that is defined when the codespace starts
2431

2532
```bash
26-
echo $PATCHDIR/patch.diff
33+
ls $PATCHDIR
2734
```
35+
36+
lists all patch files in your patch directory, allowing you to easily
37+
see and verify the patch files you have created.

0 commit comments

Comments
 (0)