void-linux / void-linux/void-docs

4. XBPS Package Manager documentation is deadlocked

オープン
#779 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
217
フォーク
212
平均マージ
2日 21時間
マージ済み PR(30日)
1

説明

I collected some examples and arguments, and old issues like #616, to show how much could be won be harmonizing the XBPS pages at 4. and 4.1 with the rest and the man pages. In total accordance with 1.2 About This Handbook

purpose of this document is to explain how to install, configure, and maintain Void Linux systems

The "Void" is important. This specific "system maintenance" via XBPS commands is exactly what 4. XBPS Package Manager takes care of, after 2. Installation and 3. Configuration.

My initial motivation was to slip in sth about periodical --clean-cache, because I saw a reddit post and checked it, also with the docs. The cache is mentioned beside the man page link to xbps-remove, but it is up to the user to draw conclusions. The subtle problem behind it is, after cache cleaning, you have less to downgrade back to. But the solution is not to be silent and hope it will never overfill.

Then the "Switch to LTS series" question. IMO the only "trick" is to ignorepkg=linux, to deactivate the base-system dep, which is there for a good reason. "Ignoring Packages" in 4.1 Advanced Usage walks you through exactly that situation:

For example, you may wish to use doas(1) instead of sudo(8), but will be unable to remove the sudo package due to it being a dependency of the base-system package. To remove it, you will need to ignore the sudo package.

But now all this quite basic XBPS is repeated in 3. Configuration, 11. Kernel. One solution would be to mention xbps itself and the kernel as special packages: xbps can need a second update (and there is a static version), and the kernel is a package with "choices" (series, LTS, even DKMS) and a important (boot!) install-hook.

("Kernel configuration" is double unlucky: I associate this with kconfig, and I see the contents as a part of Void system maintenance via XBPS.)

xbps-reconfigure -f linux<x>.<y> is shown twice, once with xbps-alternatives and below with Install hooks.

install-hooks...Now I realise why I never found this:

 * Executes the post ACTION on its INSTALL script (which can be shown by
 running `xbps-query --property=install-script pkg' ).

It is in man xbps-reconfigure. "install-script" is not mentioned in man xbps-query or the docs.

I stop here, you can check my comments in 3 other issues by sorting by updates, and also check the one about TOC panel navigation (I closed it already, it is technical). Plus some of the threads on voidlinux subreddit.

This is the best summary I can make -- so I give up for the moment. I don't regret at all my research and efforts, and I hope you don't misunderstand my tone.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

参照されている XBPS の man ページおよび関連する issue と併せて、3. Configuration、4. XBPS Package Manager、4.1 Advanced Usage、11. Kernel の各セクションを確認してください。まず対象範囲を絞って定め、重複している説明や不足している説明を解消します。合意した XBPS のメンテナンス指針に一貫性があり、行き詰まりが解消されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。