Add usage example to the help info

Aperta
#74 10 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
c
Ambito
cli

Direzione di ricerca

The payload does not name the file holding the help text, so first search the source for the 'Usage:' string that kmod prints on an invalid command. Before editing, settle whether kmod modinfo is meant to work, since the thread has no answer. Done means the usage text shows how a command name is passed to kmod directly, and the 'invalid command' output is checked by running the binary.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation enhancement good first issue

In general, kmod is used by creating symlinks with the names of commands. If that is not an option, and kmod needs to be called directly, it is not clear how to pass it the name of the command to use.

For example:

$ /usr/bin/kmod modinfo hid-generic
invalid command 'modinfo'
kmod - Manage kernel modules: list, load, unload, etc
Usage:
        kmod [options] command [command_options]

The way I read the usage example, kmod modinfo hid-generic should be a perfectly fine way to run the modinfo command. How is this intended to work, and can the usage example be updated to be more clear?

Lingua principale
C
Stelle
116
Fork
70
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di kmod-project/kmod

Tutte le issue di kmod-project/kmod

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.