タグ付けされた質問 「documentation」

ソフトウェアの特徴と機能を詳述するシステムユーザー向けのマニュアルまたはその他の情報。

3
カーネルセクション9のマンページに、関数、データ構造、およびヘッダーを文書化する方法を教えてください。
カーネルソースには、たとえば次のように文書化された関数とデータ構造が含まれていますpanic.c。 /** * panic - halt the system * @fmt: The text string to print * * Display a message, then perform cleanups. * * This function never returns. */ void panic(const char *fmt, ...) 毎回ソースを調べる代わりに、これらのAPIをマンページとして表示し、この既存のドキュメントフレームワークを活用すると便利です。 前述の関数とデータ構造を文書化したカーネルセクション9マンページ(/usr/share/man/man9)をどのようにインストール/作成しますか?


2
Linuxファイルシステム階層にREADMEがないのはなぜですか?
Linuxファイルシステム階層(FHS)には、多くの重要なディレクトリが含まれています。たとえば/sys/class/input、PS / 2キーボード設定で遊んでいるところを発見しました。 しかし、これらの重要なディレクトリはすべて別の場所に文書化されているためman /sys/class/input、特定の時点で何が起こるかを説明するようには機能しません。 README階層にファイルを配置して、人々が特定のレベルで何が行われているのかを学習し、内容を操作しやすくしませんか?デバイスが独自READMEのをマウントすることさえできれば、それは本当に素晴らしいことです。

1
`info`と` pinfo`の違い
違いは何だinfoとpinfo色のほかには? pinfo です: 情報ファイルを表示するためのプログラム しばらくは、info次のとおりです。 Info形式のドキュメントを読む これら2つのコマンドの違いをウェブで検索しようとしましたが、有用な情報が見つかりませんでした。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.