mirror of
https://github.com/hardkernel/linux.git
synced 2026-06-04 18:19:28 +09:00
f7cf335c7d
Randy Dunlap says: ==================== net/tipc: fix all kernel-doc and add TIPC networking chapter Fix lots of net/tipc/ kernel-doc warnings. Add many struct field and function parameter descriptions. Then add a TIPC chapter to the networking documentation book. All patches have been rebased to current net-next. Note: some of the struct members and function parameters are marked with "FIXME". They could use some additional descriptions if someone could help add to them. Thanks. ==================== Link: https://lore.kernel.org/r/20201129183251.7049-1-rdunlap@infradead.org Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.