Skip to content

Split man pages#799

Merged
tsipinakis merged 2 commits into
dunst-project:masterfrom
fwsmit:doc-update
Jan 27, 2021
Merged

Split man pages#799
tsipinakis merged 2 commits into
dunst-project:masterfrom
fwsmit:doc-update

Conversation

@fwsmit
Copy link
Copy Markdown
Member

@fwsmit fwsmit commented Dec 25, 2020

The dunst man page was getting really big , so I figured it was best to split it up. This PR splits the dunst man page into a section 1 and section 5 man page. Section 1 contains all the documentation to running the dunst command. Section 5 contains the documentation regarding the configuration of dunst. I also updated and added to a few parts of the man page.
Don't merge before #781, because I will have to fix a few conflicts (should have based this on the wayland branch...).

@codecov-io
Copy link
Copy Markdown

codecov-io commented Dec 25, 2020

Codecov Report

Merging #799 (ece5c4f) into master (0e6997b) will decrease coverage by 5.51%.
The diff coverage is 4.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #799      +/-   ##
==========================================
- Coverage   65.01%   59.49%   -5.52%     
==========================================
  Files          30       36       +6     
  Lines        5276     5795     +519     
==========================================
+ Hits         3430     3448      +18     
- Misses       1846     2347     +501     
Flag Coverage Δ
unittests 59.49% <4.00%> (-5.52%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/draw.c 0.00% <0.00%> (ø)
src/dunst.c 10.09% <0.00%> (-0.29%) ⬇️
src/input.c 0.00% <0.00%> (ø)
src/output.c 0.00% <0.00%> (-37.50%) ⬇️
src/wayland/libgwater-wayland.c 0.00% <0.00%> (ø)
src/wayland/pool-buffer.c 0.00% <0.00%> (ø)
src/wayland/protocols/idle-client-header.h 0.00% <0.00%> (ø)
...tocols/wlr-layer-shell-unstable-v1-client-header.h 0.00% <0.00%> (ø)
src/wayland/wl.c 0.00% <0.00%> (ø)
src/x11/x.c 2.29% <0.00%> (+0.08%) ⬆️
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e6997b...ece5c4f. Read the comment docs.

Copy link
Copy Markdown
Member

@bebehei bebehei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I absolutely appreciate it! Gives more clarity about the stuff.

Also ppl from sway and wayland side are used to have multiple manpages in different man sections. Especially section 5 is used there heavily.

Comment thread Makefile
@fwsmit fwsmit force-pushed the doc-update branch 2 times, most recently from 860f675 to dcc85ed Compare December 28, 2020 16:22
@fwsmit
Copy link
Copy Markdown
Member Author

fwsmit commented Dec 28, 2020

I absolutely appreciate it! Gives more clarity about the stuff.

Also ppl from sway and wayland side are used to have multiple manpages in different man sections. Especially section 5 is used there heavily.

Yep, that's where I got it from. It might take some getting used to, but in the end it's better.

@tsipinakis
Copy link
Copy Markdown
Member

tsipinakis commented Dec 29, 2020

As I mentioned here this is blocked on #781

@fwsmit
Copy link
Copy Markdown
Member Author

fwsmit commented Jan 6, 2021

Rebased this one on #798, so it should be good to go as well.

@fwsmit
Copy link
Copy Markdown
Member Author

fwsmit commented Jan 27, 2021

I rebased again. It's ready for merging now.

@tsipinakis tsipinakis merged commit e90f605 into dunst-project:master Jan 27, 2021
@fwsmit fwsmit deleted the doc-update branch February 16, 2022 09:30
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.55%. Comparing base (22d108f) to head (63103f9).
⚠️ Report is 962 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #799      +/-   ##
==========================================
+ Coverage   59.51%   59.55%   +0.03%     
==========================================
  Files          36       36              
  Lines        5800     5790      -10     
==========================================
- Hits         3452     3448       -4     
+ Misses       2348     2342       -6     
Flag Coverage Δ
unittests 59.55% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants