[PATCH 4/4] drm: pl111: Update documentation

[Emil Velikov]

Hi all,

Inspired by Linus and my personal confusion with the report, allow me
to put some suggestions. Followed by an illustrative example.

On Wed, 10 Jun 2020 at 08:38, kernel test robot <lkp at intel.com> wrote:
>
> Hi Linus,
>
> I love your patch! Perhaps something to improve:
>
> [auto build test WARNING on drm-exynos/exynos-drm-next]
> [also build test WARNING on drm-intel/for-linux-next tegra-drm/drm/tegra/for-next linus/master v5.7 next-20200609]
One thing which was always inclear me - is the warning identical in
all the branches listed.

> [cannot apply to drm-tip/drm-tip drm/drm-next]
> [if your patch is applied to the wrong git tree, please drop us a note to help
> improve the system. BTW, we also suggest to use '--base' option to specify the
> base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
>
Reference to the manual tends to be better than an old SO thread.

> url:    https://github.com/0day-ci/linux/commits/Linus-Walleij/drm-pl111-Credit-where-credit-is-due/20200610-041025
> base:   https://git.kernel.org/pub/scm/linux/kernel/git/daeinki/drm-exynos.git exynos-drm-next
> reproduce: make htmldocs
>
> If you fix the issue, kindly add following tag as appropriate
> Reported-by: kernel test robot <lkp at intel.com>
>
> All warnings (new ones prefixed by >>, old ones prefixed by <<):
>
Please do not list old warnings/errors. They only distract and dilute
what/where the problem is.


> vim +1 drivers/gpu/drm/pl111/pl111_drv.c
>
> e559355a9da60a Thomas Gleixner 2019-06-01  @1  // SPDX-License-Identifier: GPL-2.0-only
> bed41005e6174d Tom Cooksey     2017-04-12   2  /*
> bed41005e6174d Tom Cooksey     2017-04-12   3   * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
> bed41005e6174d Tom Cooksey     2017-04-12   4   *
> bed41005e6174d Tom Cooksey     2017-04-12   5   * Parts of this file were based on sources as follows:
> bed41005e6174d Tom Cooksey     2017-04-12   6   *
> bed41005e6174d Tom Cooksey     2017-04-12   7   * Copyright (c) 2006-2008 Intel Corporation
> bed41005e6174d Tom Cooksey     2017-04-12   8   * Copyright (c) 2007 Dave Airlie <airlied at linux.ie>
> bed41005e6174d Tom Cooksey     2017-04-12   9   * Copyright (C) 2011 Texas Instruments
> bed41005e6174d Tom Cooksey     2017-04-12  10   */
> bed41005e6174d Tom Cooksey     2017-04-12  11
>
> :::::: The code at line 1 was first introduced by commit
> :::::: e559355a9da60a2388893d9e9da66c79fd604b9a treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 443
>
> :::::: TO: Thomas Gleixner <tglx at linutronix.de>
> :::::: CC: Greg Kroah-Hartman <gregkh at linuxfoundation.org>
>
All of this seems useful when debugging the kernel test robot itself.
Which in this case is misleading as hell.


Here is something which is much shorter, with clearer structure and
reads much easier.

---
Hi Linus,

This is an automated message from your friendly test robot.
We've noticed some issues with your patch although being a robot,
kindly double-check the results.

Branches:
[if the warning/errors are the same group them, otherwise split them
in separate sections]

- drm-exynos/exynos-drm-next [1]: WARNING
- drm-intel/for-linux-next [2]: WARNING
- .... : WARNING
drivers/gpu/drm/pl111/pl111_drv.c:1: warning: 'ARM PrimeCell PL111
CLCD Driver' not found
- tegra-drm/drm/tegra/for-next [3]: WARNING
some other warning
- drm-tip/drm-tip [4] drm/drm-next [5]: cannot apply series

Note: when submitting patches, please use `--base` as documented in
https://git-scm.com/docs/git-format-patch.


To reproduce:
 - wget https://url/to/build/toolchain // when applicable
 - wget https://url/to/config // when applicable
 - make htmldocs // use explicit make command instead of magic shell
script, as seen in the cross build reports


If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp at intel.com>

Thank you
The LKP team

[1] URI to the drm-exynos/exynos-drm-next repo
[2] URI to the drm-intel/for-linux-next repo
[3] URI to the ...