* [PR PATCH] Manual.md: designate place for Void-specific documentation
@ 2020-04-07 20:23 Chocimier
2020-04-12 8:54 ` ericonr
` (6 more replies)
0 siblings, 7 replies; 8+ messages in thread
From: Chocimier @ 2020-04-07 20:23 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 528 bytes --]
There is a new pull request by Chocimier against master on the void-packages repository
https://github.com/Chocimier/void-packages-org readme.voidlinux
https://github.com/void-linux/void-packages/pull/20735
Manual.md: designate place for Void-specific documentation
This is meant to be used instead of install.msg for not critical information, and maybe some information from wiki.
I will clean up install.msgs if this is accepted.
A patch file from https://github.com/void-linux/void-packages/pull/20735.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-readme.voidlinux-20735.patch --]
[-- Type: text/x-diff, Size: 1362 bytes --]
From dcd23b8ca06b42d9db8afc24b07055d97a91dcde Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20W=C3=B3jcik?= <chocimier@tlen.pl>
Date: Tue, 7 Apr 2020 22:21:28 +0200
Subject: [PATCH] Manual.md: designate place for Void-specific documentation
---
Manual.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/Manual.md b/Manual.md
index 92b57b1b2c2..53e8fae2bf8 100644
--- a/Manual.md
+++ b/Manual.md
@@ -67,6 +67,7 @@ packages for XBPS, the `Void Linux` native packaging system.
* [update-desktopdb](#triggers_update_desktopdb)
* [x11-fonts](#triggers_x11_fonts)
* [xml-catalog](#triggers_xml_catalog)
+ * [Void specific documentation](#documentation)
* [Notes](#notes)
* [Contributing via git](#contributing)
* [Help](#help)
@@ -1936,6 +1937,14 @@ During removal it uses `xmlcatmgr` to remove all catalogs passed to it by the
To include this trigger use the `sgml_entries` variable or/and the `xml_entries` variable,
as the trigger won't do anything unless either of them are defined.
+<a id="documentation"></a>
+### Void specific documentation
+
+When you want document details of package's configuration and usage specific to Void Linux,
+not covered by upstream documentation, put notes into
+`srcpkgs/<pkgname>/files/README.voidlinux` and install with
+`vdoc "${FILESDIR}/README.voidlinux"`.
+
<a id="notes"></a>
### Notes
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
@ 2020-04-12 8:54 ` ericonr
2020-04-20 4:22 ` CameronNemo
` (5 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: ericonr @ 2020-04-12 8:54 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 241 bytes --]
New comment by ericonr on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-612584283
Comment:
Huh, this is great! I will wait for it to be merged, then I can make a PR for the info at void-docs.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
2020-04-12 8:54 ` ericonr
@ 2020-04-20 4:22 ` CameronNemo
2020-04-20 4:23 ` CameronNemo
` (4 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: CameronNemo @ 2020-04-20 4:22 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 805 bytes --]
New comment by CameronNemo on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-616299608
Comment:
Which wiki information? Which `INSTALL.msg`s might be replaced by this?
Note, here is a current list of all install messages that are note the "removed package" string:
http://ix.io/2iLy
I feel like the apparmor, bluez/bluez-qt5/blueman, wicd, socklog-void messages could be moved to the official docs.
For rng-tools, "Note that version 6 of rng-tools has modified the rngd options" -- version 6 was released in July of 2017! Maybe time to remove that note...
I implore contributors to:
1. clean up what we have in the official docs and INSTALL.msg files
2. take stock of which information from the wiki is important and needs to be migrated
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
2020-04-12 8:54 ` ericonr
2020-04-20 4:22 ` CameronNemo
@ 2020-04-20 4:23 ` CameronNemo
2020-04-20 5:01 ` CameronNemo
` (3 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: CameronNemo @ 2020-04-20 4:23 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 804 bytes --]
New comment by CameronNemo on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-616299608
Comment:
Which wiki information? Which `INSTALL.msg`s might be replaced by this?
Note, here is a current list of all install messages that are not the "removed package" string:
http://ix.io/2iLy
I feel like the apparmor, bluez/bluez-qt5/blueman, wicd, socklog-void messages could be moved to the official docs.
For rng-tools, "Note that version 6 of rng-tools has modified the rngd options" -- version 6 was released in July of 2017! Maybe time to remove that note...
I implore contributors to:
1. clean up what we have in the official docs and INSTALL.msg files
2. take stock of which information from the wiki is important and needs to be migrated
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
` (2 preceding siblings ...)
2020-04-20 4:23 ` CameronNemo
@ 2020-04-20 5:01 ` CameronNemo
2020-04-20 5:09 ` CameronNemo
` (2 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: CameronNemo @ 2020-04-20 5:01 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 342 bytes --]
New comment by CameronNemo on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-616310296
Comment:
I guess optional dependencies could be documented there, but I am not sure how many people will look... `python3-matplotlib` and `scapy` both use INSTALL.msg files to suggest optional dependencies.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
` (3 preceding siblings ...)
2020-04-20 5:01 ` CameronNemo
@ 2020-04-20 5:09 ` CameronNemo
2020-04-20 17:59 ` Chocimier
2020-12-30 7:25 ` [PR PATCH] [Merged]: " the-maldridge
6 siblings, 0 replies; 8+ messages in thread
From: CameronNemo @ 2020-04-20 5:09 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 503 bytes --]
New comment by CameronNemo on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-616310296
Comment:
I guess optional dependencies could be documented there, but I am not sure how many people will look... `python3-matplotlib` and `scapy` both use INSTALL.msg files to suggest optional dependencies.
Likewise service configuration that is less-than-straightforward (e.g. mopidy, minio) seems like a good category of information to put in these README files.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
` (4 preceding siblings ...)
2020-04-20 5:09 ` CameronNemo
@ 2020-04-20 17:59 ` Chocimier
2020-12-30 7:25 ` [PR PATCH] [Merged]: " the-maldridge
6 siblings, 0 replies; 8+ messages in thread
From: Chocimier @ 2020-04-20 17:59 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 584 bytes --]
New comment by Chocimier on void-packages repository
https://github.com/void-linux/void-packages/pull/20735#issuecomment-616717743
Comment:
Install.msg is meant for most important messages like possible data loss or being locked out (openssh) or so. Optional dependencies will stay here for now, but there is proposal that they will be moved to xbps-query output.
I want to move other messages that are not trivial (`dhewm3` is, for example), into readmes.
For wiki, i won't move anything, just creating space for content that was asked to move to docs, but do not fit there.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PR PATCH] [Merged]: Manual.md: designate place for Void-specific documentation
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
` (5 preceding siblings ...)
2020-04-20 17:59 ` Chocimier
@ 2020-12-30 7:25 ` the-maldridge
6 siblings, 0 replies; 8+ messages in thread
From: the-maldridge @ 2020-12-30 7:25 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 360 bytes --]
There's a merged pull request on the void-packages repository
Manual.md: designate place for Void-specific documentation
https://github.com/void-linux/void-packages/pull/20735
Description:
This is meant to be used instead of install.msg for not critical information, and maybe some information from wiki.
I will clean up install.msgs if this is accepted.
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2020-12-30 7:25 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
2020-04-12 8:54 ` ericonr
2020-04-20 4:22 ` CameronNemo
2020-04-20 4:23 ` CameronNemo
2020-04-20 5:01 ` CameronNemo
2020-04-20 5:09 ` CameronNemo
2020-04-20 17:59 ` Chocimier
2020-12-30 7:25 ` [PR PATCH] [Merged]: " the-maldridge
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).