Krolyxon
Commit 86a83c1

Branches

Refs →

nsxiv86a83c1

CHANGELOG: use reference style links (#325)

Originally we stopped doing links in the CHANGELOG since it harmed
readability when reading the raw markdown file. However we can use
reference styles links instead.

* Pros
  - Doesn't harm readability.
  - We can link to proper thread on the proper repo (`CodeBerg/nsxiv`
    for newer threads, `nsxiv-record` for wiped ones)
  - The links will be clickable on the [webpage]
  - Both GitHub and Codeberg support reference style links, as well as
    lowdown (which we use for building the webpage)

[webpage]: https://nsxiv.codeberg.page/changelog/

* Cons
  - Slightly higher maintainance burden.
  - Larger file size.
Author
NRK
Date
2022-06-27 21:20 +0200
Parent
f78626c
Commit
86a83c1ec5ba2a6e5130a373fca394a7002060c7

+143 −72

2 files changed

Browse files Patch
−Context 3+
  1. M CHANGELOG.md +141 −71
  2. M CONTRIBUTING.md +2 −1
M CHANGELOG.md View
@@ -26,27 +26,40 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
2626
2727 * Development and main repository moved over to Codeberg.
2828 See the special note above for more info.
29− * `autoreload_{inotify,nop}.c` merged into a single file, `autoreload.c`. (#263)
30− * Moved all configuration related macros to `config.mk`. (#264)
29+ * `autoreload_{inotify,nop}.c` merged into a single file, `autoreload.c`. [#263]
30+ * Moved all configuration related macros to `config.mk`. [#264]
3131 * `win-title` is now called only when there's change rather than being called
32− on each redraw. (#266)
32+ on each redraw. [#266]
3333
3434 * Added:
3535
36− * Added more mimetypes to the `.desktop` entry. (#260)
37− * Added `thumb-info` for customizing the statusbar in thumbnail-mode. (#265)
38− * Added comments for building on OpenBSD. (#264)
36+ * Added more mimetypes to the `.desktop` entry. [#260]
37+ * Added `thumb-info` for customizing the statusbar in thumbnail-mode. [#265]
38+ * Added comments for building on OpenBSD. [#264]
3939
4040 * Fixes:
4141
42− * "Too many open file" error due to not closing the win-title script. (#245)
42+ * "Too many open file" error due to not closing the win-title script. [#245]
4343 * `-f` now directly starts in fullscreen mode rather than opening a normal
44− window and then going fullscreen. (#251)
45− * Broken slideshow on slow systems or fast animations. (#282)
46− * Memory leak when removing an image in thumbnail mode. (#247)
47− * Correctly setting `_NET_WM_PID`. (#251)
48− * Don't override statusbar if info script doesn't exist. (#271)
49− * Potential misbehavior regarding font. (#250)
44+ window and then going fullscreen. [#251]
45+ * Broken slideshow on slow systems or fast animations. [#282]
46+ * Memory leak when removing an image in thumbnail mode. [#247]
47+ * Correctly setting `_NET_WM_PID`. [#251]
48+ * Don't override statusbar if info script doesn't exist. [#271]
49+ * Potential misbehavior regarding font. [#250]
50+
51+[#245]: https://codeberg.org/nsxiv/nsxiv-record/pulls/245
52+[#247]: https://codeberg.org/nsxiv/nsxiv-record/pulls/247
53+[#250]: https://codeberg.org/nsxiv/nsxiv-record/pulls/250
54+[#251]: https://codeberg.org/nsxiv/nsxiv-record/pulls/251
55+[#263]: https://codeberg.org/nsxiv/nsxiv-record/pulls/263
56+[#264]: https://codeberg.org/nsxiv/nsxiv-record/pulls/264
57+[#260]: https://codeberg.org/nsxiv/nsxiv-record/pulls/260
58+[#264]: https://codeberg.org/nsxiv/nsxiv-record/pulls/264
59+[#265]: https://codeberg.org/nsxiv/nsxiv-record/pulls/265
60+[#266]: https://codeberg.org/nsxiv/nsxiv-record/pulls/266
61+[#271]: https://codeberg.org/nsxiv/nsxiv-record/pulls/271
62+[#282]: https://codeberg.org/nsxiv/nsxiv-record/pulls/282
5063
5164 - - -
5265
@@ -57,26 +70,39 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
5770
5871 * Window title is now customizeable via `win-title`, cli flag `-T` and related
5972 config.h options are removed. See `WINDOW TITLE` section of the manpage for
60− more info. (#213)
73+ more info. [#213]
6174 * Imlib2 cache size is now set based on total memory percentage, by default
62− set to 3%. (#184)
63− * Removed some non-POSIX extensions in the Makefile. (#225)
75+ set to 3%. [#184]
76+ * Removed some non-POSIX extensions in the Makefile. [#225]
6477
6578 * Added:
6679
67− * Ability to customize thumbnail mode mouse-bindings via `config.h`. (#167)
68− * Option to set statusbar position to top via `config.h`. (#231)
69− * New keybinding <kbd>z</kbd> to scroll to center. (#203)
80+ * Ability to customize thumbnail mode mouse-bindings via `config.h`. [#167]
81+ * Option to set statusbar position to top via `config.h`. [#231]
82+ * New keybinding <kbd>z</kbd> to scroll to center. [#203]
7083
7184 * Fixes:
7285
7386 * Manpage cleanup: avoid confusing wording and document thumbnail mode
74− mouse-bindings. (#186)
75− * Wrong jpeg exif orientation with Imlib2 v1.7.5 (and above). (#188)
76− * Animation slowdown when zoomed in. (#200)
77− * Reset statusbar after failed keyhandler. (#191)
78− * Window title not working on certain WMs. (#234)
79− * Various compiler warnings. (#197)
87+ mouse-bindings. [#186]
88+ * Wrong jpeg exif orientation with Imlib2 v1.7.5 (and above). [#188]
89+ * Animation slowdown when zoomed in. [#200]
90+ * Reset statusbar after failed keyhandler. [#191]
91+ * Window title not working on certain WMs. [#234]
92+ * Various compiler warnings. [#197]
93+
94+[#167]: https://codeberg.org/nsxiv/nsxiv-record/pulls/167
95+[#184]: https://codeberg.org/nsxiv/nsxiv-record/pulls/184
96+[#186]: https://codeberg.org/nsxiv/nsxiv-record/pulls/186
97+[#188]: https://codeberg.org/nsxiv/nsxiv-record/pulls/188
98+[#191]: https://codeberg.org/nsxiv/nsxiv-record/pulls/191
99+[#197]: https://codeberg.org/nsxiv/nsxiv-record/pulls/197
100+[#200]: https://codeberg.org/nsxiv/nsxiv-record/pulls/200
101+[#203]: https://codeberg.org/nsxiv/nsxiv-record/pulls/203
102+[#213]: https://codeberg.org/nsxiv/nsxiv-record/pulls/213
103+[#225]: https://codeberg.org/nsxiv/nsxiv-record/pulls/225
104+[#231]: https://codeberg.org/nsxiv/nsxiv-record/pulls/231
105+[#234]: https://codeberg.org/nsxiv/nsxiv-record/pulls/234
80106
81107 - - -
82108
@@ -85,47 +111,74 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
85111
86112 * Changes:
87113
88− * Statusbar made optional via `HAVE_LIBFONTS`. (#95)
89− * Remove library auto-detection, use `OPT_DEP_DEFAULT` instead. (#71)
114+ * Statusbar made optional via `HAVE_LIBFONTS`. [#95]
115+ * Remove library auto-detection, use `OPT_DEP_DEFAULT` instead. [#71]
90116 * Example scripts will now be installed into `EGPREFIX`
91117 (`$(PREFIX)/share/doc/nsxiv/examples` by default). See README for more
92− info. (#86)
118+ info. [#86]
93119
94120 * Added:
95121
96− * Animated webp support (optional via `HAVE_LIBWEBP`). (#20)
97− * New mouse-binding <kbd>Ctrl-Button1</kbd> for relative drag. (#117)
98− * Ability to configure colors and fonts in `config.h`. (#115)
99− * Ability to configure navigation width area in `config.h`. (#155)
122+ * Animated webp support (optional via `HAVE_LIBWEBP`). [#20]
123+ * New mouse-binding <kbd>Ctrl-Button1</kbd> for relative drag. [#117]
124+ * Ability to configure colors and fonts in `config.h`. [#115]
125+ * Ability to configure navigation width area in `config.h`. [#155]
100126 * Ability to customize the set of modifiers used when processing keybindings
101− in `config.h` via `USED_MODMASK`. (#150)
127+ in `config.h` via `USED_MODMASK`. [#150]
102128 * Ability to configure Imlib2's cache size for better image (re)loading
103− performance in `config.h`. (#171)
129+ performance in `config.h`. [#171]
104130 * Cli flag `-0` for sending null-seperated file-list to standard out (`-o`),
105131 and key-handler and receiving null-seperated file-list via stdin (`-i`).
106− (#68) (#141) (#164)
107− * Export environment variable `NSXIV_USING_NULL` to key-handler. (#164)
108− * Embed new nsxiv icon. (#163)
109− * `make install-icon` to install icons. (#80) (#96)
110− * `make install-desktop` to install .desktop entry. (#80) (#96)
111− * `make install-all` to install everything. (#80) (#96)
112− * Configurable `KEYHANDLER_ABORT` in `config.h`. (#91) (#172)
113− * Statusbar message upon key-handler activation. (#98)
132+ [#68] [#141] [#164]
133+ * Export environment variable `NSXIV_USING_NULL` to key-handler. [#164]
134+ * Embed new nsxiv icon. [#163]
135+ * `make install-icon` to install icons. [#80] [#96]
136+ * `make install-desktop` to install .desktop entry. [#80] [#96]
137+ * `make install-all` to install everything. [#80] [#96]
138+ * Configurable `KEYHANDLER_ABORT` in `config.h`. [#91] [#172]
139+ * Statusbar message upon key-handler activation. [#98]
114140 * Ability to write custom C functions in `config.h` and use them via
115− keybindings. (#76)
141+ keybindings. [#76]
116142
117143 * Fixes:
118144
119145 * Not able to use `KEYHANDLER_ABORT` key (<kbd>Escape</kbd> by default) in
120− regular keybindings. (#91)
121− * Memory leak related to Xresources. (#134)
122− * Memory leak in gif loader. (#165)
123− * Better handle gif colormap and prevent out-of-bound access. (#165)
124− * Prevent crash when zooming out in very small images. (#178)
125− * Removed non-POSIX commands and extensions from `Makefile`. (#71)
126− * Regression where nsxiv wouldn't run on non-TrueColor X server. (#114)
146+ regular keybindings. [#91]
147+ * Memory leak related to Xresources. [#134]
148+ * Memory leak in gif loader. [#165]
149+ * Better handle gif colormap and prevent out-of-bound access. [#165]
150+ * Prevent crash when zooming out in very small images. [#178]
151+ * Removed non-POSIX commands and extensions from `Makefile`. [#71]
152+ * Regression where nsxiv wouldn't run on non-TrueColor X server. [#114]
127153 * Wrong comments in `config.h` and description in `manpage`.
128− (#105) (#106) (#152)
154+ [#105] [#106] [#152]
155+
156+[#20]: https://codeberg.org/nsxiv/nsxiv-record/pulls/20
157+[#68]: https://codeberg.org/nsxiv/nsxiv-record/pulls/68
158+[#71]: https://codeberg.org/nsxiv/nsxiv-record/pulls/71
159+[#76]: https://codeberg.org/nsxiv/nsxiv-record/pulls/76
160+[#80]: https://codeberg.org/nsxiv/nsxiv-record/pulls/80
161+[#86]: https://codeberg.org/nsxiv/nsxiv-record/pulls/86
162+[#91]: https://codeberg.org/nsxiv/nsxiv-record/pulls/91
163+[#95]: https://codeberg.org/nsxiv/nsxiv-record/pulls/95
164+[#96]: https://codeberg.org/nsxiv/nsxiv-record/pulls/96
165+[#98]: https://codeberg.org/nsxiv/nsxiv-record/pulls/98
166+[#105]: https://codeberg.org/nsxiv/nsxiv-record/pulls/105
167+[#106]: https://codeberg.org/nsxiv/nsxiv-record/pulls/106
168+[#114]: https://codeberg.org/nsxiv/nsxiv-record/pulls/114
169+[#115]: https://codeberg.org/nsxiv/nsxiv-record/pulls/115
170+[#117]: https://codeberg.org/nsxiv/nsxiv-record/pulls/117
171+[#134]: https://codeberg.org/nsxiv/nsxiv-record/pulls/134
172+[#141]: https://codeberg.org/nsxiv/nsxiv-record/pulls/141
173+[#150]: https://codeberg.org/nsxiv/nsxiv-record/pulls/150
174+[#152]: https://codeberg.org/nsxiv/nsxiv-record/pulls/152
175+[#155]: https://codeberg.org/nsxiv/nsxiv-record/pulls/155
176+[#163]: https://codeberg.org/nsxiv/nsxiv-record/pulls/163
177+[#164]: https://codeberg.org/nsxiv/nsxiv-record/pulls/164
178+[#165]: https://codeberg.org/nsxiv/nsxiv-record/pulls/165
179+[#171]: https://codeberg.org/nsxiv/nsxiv-record/pulls/171
180+[#172]: https://codeberg.org/nsxiv/nsxiv-record/pulls/172
181+[#178]: https://codeberg.org/nsxiv/nsxiv-record/pulls/178
129182
130183 - - -
131184
@@ -134,7 +187,9 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
134187
135188 * Fixes:
136189
137− * Source tarball failing build ([#66](https://github.com/nsxiv/nsxiv/pull/66))
190+ * Source tarball failing build [#66]
191+
192+[#66]: https://codeberg.org/nsxiv/nsxiv-record/pulls/66
138193
139194 - - -
140195
@@ -143,32 +198,47 @@ references *above* can be found on the new main nsxiv repository on CodeBerg.
143198
144199 * Changes:
145200
146− * Re-release under the name nsxiv
201+ * Re-release under the name nsxiv.
147202 * Xresources `Sxiv.foreground` and `Sxiv.background` changed
148− to `Nsxiv.window.foreground` and `Nsxiv.window.background`
149− * Xresources `Sxiv.font` changed to `Nsxiv.bar.font`
150− * Rework the build system ([#19](https://github.com/nsxiv/nsxiv/pull/19)). Now by default we'll build
151− with only optional dependencies that are already installed
203+ to `Nsxiv.window.foreground` and `Nsxiv.window.background`.
204+ * Xresources `Sxiv.font` changed to `Nsxiv.bar.font`.
205+ * Rework the build system. Now by default we'll build with only optional
206+ dependencies that are already installed. [#19]
152207
153208 * Added:
154209
155− * Fill scale mode ([#2](https://github.com/nsxiv/nsxiv/pull/2))
156− * Configurable X window title (via `config.h` and the `-T` flag) ([#23](https://github.com/nsxiv/nsxiv/pull/23))
157− * Support custom bar colors via Xresources ([#19](https://github.com/nsxiv/nsxiv/pull/19))
158− * Support custom mark color via Xresources ([#51](https://github.com/nsxiv/nsxiv/pull/51))
159− * Toggle animation playback with <kbd>Ctrl-a</kbd> ([#33](https://github.com/nsxiv/nsxiv/pull/33))
160− * Set `_NET_WM_PID` and `WM_CLIENT_MACHINE` X properties ([#13](https://github.com/nsxiv/nsxiv/pull/13))
161− * Set `ICCCM WM manager` hints ([#12](https://github.com/nsxiv/nsxiv/pull/12))
210+ * Fill scale mode. [#2]
211+ * Configurable X window title (via `config.h` and the `-T` flag). [#23]
212+ * Support custom bar colors via Xresources. [#19]
213+ * Support custom mark color via Xresources. [#51]
214+ * Toggle animation playback with <kbd>Ctrl-a</kbd>. [#33]
215+ * Set `_NET_WM_PID` and `WM_CLIENT_MACHINE` X properties. [#13]
216+ * Set `ICCCM WM manager` hints. [#12]
162217
163218 * Fixes:
164219
165− * Cli flag `-G` not initially setting gamma ([#31](https://github.com/nsxiv/nsxiv/pull/31))
166− * Wrong keybinding description in the manpage ([#14](https://github.com/nsxiv/nsxiv/pull/14))
167− * .desktop entry not advertising webp support ([#15](https://github.com/nsxiv/nsxiv/pull/15))
168− * Prevent crash when embedded into transparent window ([#3](https://github.com/nsxiv/nsxiv/pull/3))
169− * Small memory leak ([#57](https://github.com/nsxiv/nsxiv/pull/57))
170− * Rare crash when showing some GIFs ([#41](https://github.com/nsxiv/nsxiv/pull/41))
171− * Rare event where nsxiv wouldn't close after window being destroyed ([#53](https://github.com/nsxiv/nsxiv/pull/53))
220+ * Cli flag `-G` not initially setting gamma. [#31]
221+ * Wrong keybinding description in the manpage. [#14]
222+ * .desktop entry not advertising webp support. [#15]
223+ * Prevent crash when embedded into transparent window. [#3]
224+ * Small memory leak. [#57]
225+ * Rare crash when showing some GIFs. [#41]
226+ * Rare event where nsxiv wouldn't close after window being destroyed. [#53]
227+
228+[#2]: https://codeberg.org/nsxiv/nsxiv-record/pulls/2
229+[#3]: https://codeberg.org/nsxiv/nsxiv-record/pulls/3
230+[#12]: https://codeberg.org/nsxiv/nsxiv-record/pulls/12
231+[#13]: https://codeberg.org/nsxiv/nsxiv-record/pulls/13
232+[#14]: https://codeberg.org/nsxiv/nsxiv-record/pulls/14
233+[#15]: https://codeberg.org/nsxiv/nsxiv-record/pulls/15
234+[#19]: https://codeberg.org/nsxiv/nsxiv-record/pulls/19
235+[#23]: https://codeberg.org/nsxiv/nsxiv-record/pulls/23
236+[#31]: https://codeberg.org/nsxiv/nsxiv-record/pulls/31
237+[#33]: https://codeberg.org/nsxiv/nsxiv-record/pulls/33
238+[#41]: https://codeberg.org/nsxiv/nsxiv-record/pulls/41
239+[#51]: https://codeberg.org/nsxiv/nsxiv-record/pulls/51
240+[#53]: https://codeberg.org/nsxiv/nsxiv-record/pulls/53
241+[#57]: https://codeberg.org/nsxiv/nsxiv-record/pulls/57
172242
173243
174244 sxiv
M CONTRIBUTING.md View
@@ -74,7 +74,8 @@ For releases, the process is the following:
7474 changes which never made it into a release.
7575 * Use the "Changes" section to document behavior changes since the last
7676 release, the "Added" section for new features, and the "Fixes" section
77− for fixed bugs or regressions. Include pull request IDs.
77+ for fixed bugs or regressions.
78+ * Include pull request IDs with reference style links.
7879
7980 Mirroring to GitHub:
8081