Re: [RFC PATCH 0/3] Introduce Linux kernel labs documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Feb 19, 2018 at 1:22 AM, Jonathan Corbet <corbet@xxxxxxx> wrote:
> On Sun, 11 Feb 2018 20:05:43 +0200
> Daniel Baluta <daniel.baluta@xxxxxxxxx> wrote:
>
>> The Linux kernel labs documentation is a collection of "labs" for
>> various device driver topics. For each topic there are two parts: a
>> walk-through which explain the basic concepts and a hands-on part which
>> contains a few exercises.
>
> So I've only had a chance to give this a quick once-over.  It seems like
> useful stuff to have.  Naturally I have a few thoughts...
>

Hi Jon,

Great to hear that, thanks for checking them out.

> The biggest, perhaps, is that, if we're going to bring this material into
> the kernel documentation, we should integrate it properly.  So, for
> example, references to kernel functions and data structures should link to
> the documentation for those objects.  Most of the time, that can be done
> fairly simply using Sphinx markup - :c:func:`printk()`, for example.
>

Good point. They are partly added, some labs are better then others,
but we will make sure they are complete.

We noticed that some APIs we used don't have kernel doc comments.
Would it be appropriate to add them as separate patches in this
series?
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux