Krolyxon
Commit fb9686c

Branches

Refs →

nsxivfb9686c

Move uncritical files into `etc/` (#350)

This is mainly just to reduce the amount of files in the project root.
The criteria of what gets into `etc/` are the following:

* The file should not be necessary for building nsxiv. This excludes the
  `icon/*` stuff since that's needed by `window.c`.
* The file shouldn't have any valid reason to stay in the project root.
  This excludes things like `README.md`, `.gitignore` etc.
Author
NRK
Date
2022-08-09 16:21 +0200
Parent
8dc1261
Commit
fb9686c6505475f342ad94fa5ed1351f554f97fe

+13 −13

16 files changed

  1. M .github/workflows/build.yml +1 −1
  2. M Makefile +4 −4
  3. M README.md +4 −4
  4. R CHANGELOG.md → etc/CHANGELOG.md +0 −0
  5. R CONTRIBUTING.md → etc/CONTRIBUTING.md +2 −2
  6. R examples/image-info → etc/examples/image-info +0 −0
  7. R examples/key-handler → etc/examples/key-handler +0 −0
  8. R examples/thumb-info → etc/examples/thumb-info +0 −0
  9. R examples/win-title → etc/examples/win-title +0 −0
  10. R nsxiv.1 → etc/nsxiv.1 +0 −0
  11. R nsxiv.desktop → etc/nsxiv.desktop +0 −0
  12. R .woodpecker/CFLAGS → etc/woodpecker/CFLAGS +0 −0
  13. R .woodpecker/analysis.yml → etc/woodpecker/analysis.yml +1 −1
  14. R .woodpecker/build.yml → etc/woodpecker/build.yml +1 −1
  15. R .woodpecker/clang-tidy-checks → etc/woodpecker/clang-tidy-checks +0 −0
  16. R .woodpecker/spell.yml → etc/woodpecker/spell.yml +0 −0
M .github/workflows/build.yml View
@@ -21,7 +21,7 @@ jobs:
2121 ( cd "tinycc-$TCC_SHA" && ./configure && make && sudo make install; )
2222 - name: build
2323 run: |
24− CFLAGS="$(sed '/^#/d' .woodpecker/CFLAGS | paste -d ' ' -s)"
24+ CFLAGS="$(sed '/^#/d' etc/woodpecker/CFLAGS | paste -d ' ' -s)"
2525 build () {
2626 for cc in "gcc" "clang" "tcc"; do
2727 echo "### $cc - $2 build ###"
M Makefile View
@@ -66,7 +66,7 @@ install-all: install install-desktop install-icon
6666 install-desktop:
6767 @echo "INSTALL nsxiv.desktop"
6868 mkdir -p $(DESTDIR)$(PREFIX)/share/applications
69− cp nsxiv.desktop $(DESTDIR)$(PREFIX)/share/applications
69+ cp etc/nsxiv.desktop $(DESTDIR)$(PREFIX)/share/applications
7070
7171 install-icon:
7272 @echo "INSTALL icon"
@@ -91,12 +91,12 @@ install: all
9191 chmod 755 $(DESTDIR)$(PREFIX)/bin/nsxiv
9292 @echo "INSTALL nsxiv.1"
9393 mkdir -p $(DESTDIR)$(MANPREFIX)/man1
94− sed "s!EGPREFIX!$(EGPREFIX)!g; s!PREFIX!$(PREFIX)!g; s!VERSION!$(VERSION)!g" nsxiv.1 \
95− >$(DESTDIR)$(MANPREFIX)/man1/nsxiv.1
94+ sed "s!EGPREFIX!$(EGPREFIX)!g; s!PREFIX!$(PREFIX)!g; s!VERSION!$(VERSION)!g" \
95+ etc/nsxiv.1 >$(DESTDIR)$(MANPREFIX)/man1/nsxiv.1
9696 chmod 644 $(DESTDIR)$(MANPREFIX)/man1/nsxiv.1
9797 @echo "INSTALL share/nsxiv/"
9898 mkdir -p $(DESTDIR)$(EGPREFIX)
99− cp examples/* $(DESTDIR)$(EGPREFIX)
99+ cp etc/examples/* $(DESTDIR)$(EGPREFIX)
100100 chmod 755 $(DESTDIR)$(EGPREFIX)/*
101101
102102 uninstall: uninstall-icon
M README.md View
@@ -15,10 +15,10 @@ under GPLv2 and aims to be easy to modify and customize.
1515
1616 Please file a bug report if something does not work as documented or expected on
1717 [Codeberg] after making sure you are using the latest release. Contributions
18−are welcome, see [CONTRIBUTING.md] to get started.
18+are welcome, see [CONTRIBUTING] to get started.
1919
2020 [Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new
21−[CONTRIBUTING.md]: CONTRIBUTING.md#contribution-guideline
21+[CONTRIBUTING]: etc/CONTRIBUTING.md#contribution-guideline
2222
2323
2424 Features
@@ -185,7 +185,7 @@ or by using Xresources as explained in the manual. If these options are not suff
185185 you may implement your own features by following
186186 [this guide](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/CUSTOMIZATION.md).
187187
188−Due to our limited [project scope](CONTRIBUTING.md#project-scope), certain features or
188+Due to our limited [project scope](etc/CONTRIBUTING.md#project-scope), certain features or
189189 customization cannot be merged into nsxiv mainline. Following the spirit of suckless
190190 software, we host the [nsxiv-extra](https://codeberg.org/nsxiv/nsxiv-extra) repo where users
191191 are free to submit whatever patches or scripts they wish.
@@ -206,7 +206,7 @@ on CodeBerg or get a copy using git with the following command:
206206
207207 $ git clone https://codeberg.org/nsxiv/nsxiv.git
208208
209−You can view the changelog [here](CHANGELOG.md)
209+You can view the changelog [here](etc/CHANGELOG.md)
210210
211211
212212 Similar projects
R CHANGELOG.md → etc/CHANGELOG.md View

[No content changes]

R CONTRIBUTING.md → etc/CONTRIBUTING.md View
@@ -23,7 +23,7 @@ Contribution Guideline
2323 When contributing, make sure:
2424
2525 * Your contribution falls under nsxiv's scope and aim
26− * You follow the existing code style (see [.editorconfig](.editorconfig))
26+ * You follow the existing code style (see [.editorconfig](../.editorconfig))
2727 * You open the pull request from a new branch, not from master
2828 * To avoid using force pushes, especially for bigger patches. Only use them
2929 when there's merge conflicts.
@@ -68,7 +68,7 @@ For releases, the process is the following:
6868 the commit message and tag description for the release commit to "Release
6969 version N". Make sure to use an annotated tag.
7070 * Update `VERSION` macro in `config.mk`.
71− * Update the changelog (`CHANGELOG.md`):
71+ * Update the changelog (`etc/CHANGELOG.md`):
7272 * Include link to the release tarball and add the release date.
7373 * Document only the changes or fixes between releases. Don't document
7474 changes which never made it into a release.
R examples/image-info → etc/examples/image-info View

[No content changes]

R examples/key-handler → etc/examples/key-handler View

[No content changes]

R examples/thumb-info → etc/examples/thumb-info View

[No content changes]

R examples/win-title → etc/examples/win-title View

[No content changes]

R nsxiv.1 → etc/nsxiv.1 View

[No content changes]

R nsxiv.desktop → etc/nsxiv.desktop View

[No content changes]

R .woodpecker/CFLAGS → etc/woodpecker/CFLAGS View

[No content changes]

R .woodpecker/analysis.yml → etc/woodpecker/analysis.yml View
@@ -18,7 +18,7 @@ pipeline:
1818 *.c
1919 }
2020 run_tidy() {
21− checks="$(sed '/^#/d' .woodpecker/clang-tidy-checks | paste -d ',' -s)"
21+ checks="$(sed '/^#/d' etc/woodpecker/clang-tidy-checks | paste -d ',' -s)"
2222 clang-tidy --warnings-as-errors="*" --checks="$checks" --quiet *.c \
2323 -- -std="$std" $(make OPT_DEP_DEFAULT="$1" dump_cppflags)
2424 }
R .woodpecker/build.yml → etc/woodpecker/build.yml View
@@ -14,7 +14,7 @@ pipeline:
1414 wget "https://github.com/TinyCC/tinycc/archive/$TCC_SHA.tar.gz" >/dev/null
1515 tar xzf "$TCC_SHA.tar.gz" >/dev/null
1616 ( cd "tinycc-$TCC_SHA" && ./configure --config-musl && make -s -j"$(nproc)" && make install; ) >/dev/null
17− CFLAGS="$(sed '/^#/d' .woodpecker/CFLAGS | paste -d ' ' -s)"
17+ CFLAGS="$(sed '/^#/d' etc/woodpecker/CFLAGS | paste -d ' ' -s)"
1818 build () {
1919 for cc in "gcc" "clang" "tcc"; do
2020 echo "### $cc - $2 build ###"
R .woodpecker/clang-tidy-checks → etc/woodpecker/clang-tidy-checks View

[No content changes]

R .woodpecker/spell.yml → etc/woodpecker/spell.yml View

[No content changes]