tapaswenipathak/Kernel-APIs

Add man docs

Open

#18 opened on Mar 30, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (7 forks)github user discovery
first-timers-onlygood first issue

Repository metrics

Stars
 (10 stars)
PR merge metrics
 (PR metrics pending)

Description

manual-docs.sh.

./manual-docs.sh -fn="kernel API name" -t="API type" -desc="A line about API description" -n="API index, check the count in the man/ dir" -o="The input parameters required by the API"

Contributor guide

Research direction
Run the manual docs.sh script with appropriate arguments to generate man page documentation for a specific kernel API.
Tech stack
cshell
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90