Re: [PATCH 2/4] doc-rst: admin-guide: move bug bisect to a separate file

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

 



On Mon,  7 Nov 2016 17:03:17 -0200
Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote:

> Better organize the admin guide documentation by moving the
> bug bisect to a separate file.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> ---
>  Documentation/admin-guide/bug-bisect.rst  | 78 +++++++++++++++++++++++++++++++
>  Documentation/admin-guide/bug-hunting.rst | 74 -----------------------------
>  Documentation/admin-guide/index.rst       |  1 +
>  3 files changed, 79 insertions(+), 74 deletions(-)
>  create mode 100644 Documentation/admin-guide/bug-bisect.rst
> 
> diff --git a/Documentation/admin-guide/bug-bisect.rst b/Documentation/admin-guide/bug-bisect.rst
> new file mode 100644
> index 000000000000..5682d742017c
> --- /dev/null
> +++ b/Documentation/admin-guide/bug-bisect.rst
> @@ -0,0 +1,78 @@
> +Bisecting a bug
> ++++++++++++++++
> +
> +Last updated: 28 October 2016

So I wonder if we really need lines like that?  That's what Git is for,
especially since people often don't update the "last updated" lines...:)

> +Introduction
> +============
> +
> +Always try the latest kernel from kernel.org and build from source. If you are
> +not confident in doing that please report the bug to your distribution vendor
> +instead of to a kernel developer.
> +
> +Finding bugs is not always easy. Have a go though. If you can't find it don't
> +give up. Report as much as you have found to the relevant maintainer. See
> +MAINTAINERS for who that is for the subsystem you have worked on.
> +
> +Before you submit a bug report read
> +:ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`.
> +
> +Devices not appearing
> +=====================
> +
> +Often this is caused by udev/systemd. Check that first before blaming it
> +on the kernel.

A proper document should, of course, tell the poor user just how they are
supposed to do that.  

Anyway, I've applied the set of four.  I'm still not sure about keeping
some of that stuff around, but the result is clearly better than what we
had before.

One quick request: could you copy me on the 0/n cover letter when you do a
series like this?  As it is, I get the patches, but have to go digging
through the list for the cover.

Thanks,

jon
--
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