From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.0 required=3.0 tests=MAILING_LIST_MULTI,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5D8B9C43144 for ; Tue, 26 Jun 2018 09:51:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 1D7CF26837 for ; Tue, 26 Jun 2018 09:51:01 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 1D7CF26837 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934627AbeFZJuy (ORCPT ); Tue, 26 Jun 2018 05:50:54 -0400 Received: from osg.samsung.com ([64.30.133.232]:33175 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933592AbeFZJtT (ORCPT ); Tue, 26 Jun 2018 05:49:19 -0400 Received: from localhost (localhost [127.0.0.1]) by osg.samsung.com (Postfix) with ESMTP id 64E2D30BAD; Tue, 26 Jun 2018 02:49:18 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at dev.s-opensource.com Received: from osg.samsung.com ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id IbZrxLPkWnti; Tue, 26 Jun 2018 02:49:17 -0700 (PDT) Received: from smtp.s-opensource.com (177.41.130.70.dynamic.adsl.gvt.net.br [177.41.130.70]) by osg.samsung.com (Postfix) with ESMTPSA id 64DCB30B86; Tue, 26 Jun 2018 02:49:16 -0700 (PDT) Received: from mchehab by smtp.s-opensource.com with local (Exim 4.91) (envelope-from ) id 1fXkb3-0000lf-Ua; Tue, 26 Jun 2018 06:49:13 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Jacek Anaszewski , devicetree@vger.kernel.org, Ingo Molnar , linux-kernel@zh-kernel.org, Andrew Morton , linux-leds@vger.kernel.org, intel-wired-lan@lists.osuosl.org, Mark Rutland , linux-gpio@vger.kernel.org, "David S. Miller" , James Morris , Jeff Kirsher , Changbin Du , Masami Hiramatsu , netdev@vger.kernel.org, Steven Rostedt , linux-input@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, linux-scsi@vger.kernel.org, kvm@vger.kernel.org, virtualization@lists.linux-foundation.org, Andy Whitcroft , Joe Perches Subject: [PATCH 0/9] Fix references for some missing documentation files Date: Tue, 26 Jun 2018 06:49:02 -0300 Message-Id: X-Mailer: git-send-email 2.17.1 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Having nothing to do while waiting for my plane to arrive while returning back from Japan, I ended by writing a small series of patches meant to reduce the number of bad Documentation/* links that are detected by: ./scripts/documentation-file-ref-check I ended by rebasing this patch series against linux-next, because of those two patches: 3b0c3ebe2a42 Documentation: e100: Fix docs build error 805f16a5f12f Documentation: e1000: Fix docs build error They basically fix documentation builds with upstream Kernel. Both got merged on -rc2. The first two patches in this series makes the script to ignore some false positives. Patches 3 to 6 corrects the location of some documentation files. Patches 7 and 8 were actually two patches meant to fix the build error. I ended by rebasing them over linux-next, as they fix some troubles with the ReST syntax with causes warnings. Patch 9 converts Documentation/trace/histogram.txt to ReST syntax. It also had to be rebased against linux-next, due to some minor conflicts with: 064f35a95224 ("tracing: Fix some errors in histogram documentation") After this series, the script still produces 16 warnings: Documentation/devicetree/bindings/input/mtk-pmic-keys.txt: Documentation/devicetree/bindings/input/keys.txt Documentation/devicetree/bindings/input/mtk-pmic-keys.txt: Documentation/devicetree/bindings/input/keys.txt Documentation/devicetree/bindings/regulator/rohm,bd71837-regulator.txt: Documentation/devicetree/bindings/mfd/rohm,bd71837-pmic.txt Documentation/devicetree/dynamic-resolution-notes.txt: Documentation/devicetree/dt-object-internal.txt Documentation/scsi/scsi_mid_low_api.txt: Documentation/Configure.help Documentation/translations/zh_CN/HOWTO: Documentation/DocBook/ Documentation/translations/zh_CN/basic_profiling.txt: Documentation/basic_profiling Documentation/translations/zh_CN/basic_profiling.txt: Documentation/basic_profiling MAINTAINERS: Documentation/fpga/ MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt arch/powerpc/Kconfig: Documentation/vm/protection-keys.rst drivers/isdn/mISDN/dsp_core.c: Documentation/isdn/mISDN.cert drivers/scsi/Kconfig: file:Documentation/scsi/tmscsim.txt drivers/vhost/vhost.c: Documentation/virtual/lguest/lguest.c include/linux/fs_context.h: Documentation/filesystems/mounting.txt include/linux/lsm_hooks.h: Documentation/filesystems/mounting.txt IMHO, the above should be fixed by the corresponding maintainers. The ones that scarry me most are the DT binding documentation, as the binding documentation for some stuff are likely broken. Btw, two of the above are new on linux-next (include/linux/fs_context.h and include/linux/lsm_hooks.h) . That makes me wander that we should likely add some logic (or run the detect script) at checkpatch.pl or make it to call ./scripts/documentation-file-ref-check. Mauro Carvalho Chehab (9): scripts/documentation-file-ref-check: remove some false positives scripts/documentation-file-ref-check: ignore sched-pelt false positive docs: zh_CN: fix location of oops-tracing.txt devicectree: bindings: fix location of leds common file MAINTAINERS: fix location of ina2xx.txt device tree file gpio.h: fix location of gpio legacy documentation networking: e100.rst: Get rid of Sphinx warnings networking: e1000.rst: Get rid of Sphinx warnings docs: histogram.txt: convert it to ReST file format .../devicetree/bindings/leds/common.txt | 2 +- Documentation/networking/e100.rst | 27 +- Documentation/networking/e1000.rst | 187 ++- Documentation/trace/events.rst | 2 +- .../trace/{histogram.txt => histogram.rst} | 1242 +++++++++-------- Documentation/trace/index.rst | 1 + .../translations/zh_CN/oops-tracing.txt | 4 +- MAINTAINERS | 2 +- include/linux/gpio.h | 2 +- kernel/trace/Kconfig | 2 +- scripts/documentation-file-ref-check | 6 + 11 files changed, 767 insertions(+), 710 deletions(-) rename Documentation/trace/{histogram.txt => histogram.rst} (73%) -- 2.17.1