diff options
| author | Tim Newsome <tim@sifive.com> | 2023-02-28 10:53:40 -0800 |
|---|---|---|
| committer | Tim Newsome <tim@sifive.com> | 2023-02-28 10:54:48 -0800 |
| commit | 4f97898889e64579a35cf55be80c71c37ab4dd09 (patch) | |
| tree | cec668206ffd1cf00f6fdbb02761187dfb49b059 /HACKING | |
| parent | b8f4b8887b0ad51e657bbbbc244ff69455984a50 (diff) | |
| parent | d1b882f2c014258be5397067e45848fa5465b78b (diff) | |
| download | riscv-openocd-4f97898889e64579a35cf55be80c71c37ab4dd09.zip riscv-openocd-4f97898889e64579a35cf55be80c71c37ab4dd09.tar.gz riscv-openocd-4f97898889e64579a35cf55be80c71c37ab4dd09.tar.bz2 | |
Merge commit 'd1b882f2c014258be5397067e45848fa5465b78b' into from_upstream
Conflicts:
doc/openocd.texi
src/target/riscv/riscv-013.c
src/target/riscv/riscv.c
Change-Id: I8cd557a10c3d5beeaed05ecc05d4c325a9ee7e70
Diffstat (limited to 'HACKING')
| -rw-r--r-- | HACKING | 36 |
1 files changed, 31 insertions, 5 deletions
@@ -197,11 +197,11 @@ while(!done) { @endcode \note use "git add ." before commit to add new files. - Comment template, notice the short first line w/topic. The topic field - should identify the main part or subsystem the patch touches. Check - git log for examples. -@code -topic: Short comment + Commit message template, notice the short first line. + The field '<c>specify touched area</c>' + should identify the main part or subsystem the patch touches. +@code{.unparsed} +specify touched area: short comment <blank line> Longer comments over several lines, explaining (where applicable) the reason for the patch and the general idea the solution is based on, @@ -209,6 +209,32 @@ any major design decisions, etc... <blank line> Signed-off-by: ... @endcode + Examples: +@code{.unparsed} +flash/nor/atsame5: add SAME59 support + +Add new device ID +@endcode +@code{.unparsed} +flash/nor: flash driver for XYZ123 + +Add new flash driver for internal flash of ... +@endcode +@code{.unparsed} +target/cortex_m: fix segmentation fault in cmd 'soft_reset_halt' + +soft_reset_halt command failed reproducibly under following conditions: ... +Test for NULL pointer and return error ... + +Reported-by: John Reporter <rep9876@gmail.com> +Fixes: 123456789abc ("target: the commit where the problem started") +BugLink: https://sourceforge.net/p/openocd/tickets/999/ +@endcode +@code{.unparsed} +doc: fix typos +@endcode + See "git log" for more examples. + -# Next you need to make sure that your patches are on top of the latest stuff on the server and that there are no conflicts: |