Skip to content

Commit

Permalink
Add documentation how to create patches
Browse files Browse the repository at this point in the history
  • Loading branch information
lara committed Aug 8, 2024
1 parent 008f9d9 commit b0388c1
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/writing-easyconfig-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,33 @@ patches = [
]
```

##### Creating a patch file

Get the sources which you would like to patch. And create a copy to be able to create a diff file.

``` bash
cp -a <unpacked_sources> <unpacked_sources>.orig

```

Than you can make the necessary changes to the sources in the `<unpacked_sources>` that are not marked with the `.orig` extension. Once you have made all the updates to the sources you can create the `.patch` file with `diff`.

``` bash
diff -ruN <unpacked_sources>.orig <unpacked_sources> > <software_name>-<version>_<short_description>.patch
```

Please also add a discription on top of the patch file and the author or source of the patch.

Check failure on line 235 in docs/writing-easyconfig-files.md

View workflow job for this annotation

GitHub Actions / build

discription ==> description

For example:
```

Check failure on line 238 in docs/writing-easyconfig-files.md

View workflow job for this annotation

GitHub Actions / build

Fenced code blocks should be surrounded by blank lines

docs/writing-easyconfig-files.md:238 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md031.md

Check failure on line 238 in docs/writing-easyconfig-files.md

View workflow job for this annotation

GitHub Actions / build

Fenced code blocks should have a language specified

docs/writing-easyconfig-files.md:238 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md040.md
minimus2 needs delta-filter and show-coords but these were not set correctly like NUCMER
author: Lara Peeters (HPC-UGent)
diff -ru amos-3.1.0.orig/src/Pipeline/Makefile.in amos-3.1.0/src/Pipeline/Makefile.in
--- amos-3.1.0.orig/src/Pipeline/Makefile.in 2011-08-05 05:08:07.000000000 +0200
+++ amos-3.1.0/src/Pipeline/Makefile.in 2024-03-14 12:31:16.218067000 +0100
@@ -477,7 +477,8 @@
```

#### Checksums {: #common_easyconfig_param_sources_checksums }

Checksums for source files and patches can be provided via the
Expand Down

0 comments on commit b0388c1

Please sign in to comment.