From patchwork Mon Aug 8 13:14:59 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Heiser X-Patchwork-Id: 36249 Received: from mail.tu-berlin.de ([130.149.7.33]) by www.linuxtv.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bWkP1-0003GS-0P; Mon, 08 Aug 2016 13:15:35 +0000 X-tubIT-Incoming-IP: 209.132.180.67 Received: from vger.kernel.org ([209.132.180.67]) by mail.tu-berlin.de (exim-4.84_2/mailfrontend-6) with esmtp id 1bWkOy-0001Su-5r; Mon, 08 Aug 2016 15:15:34 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752168AbcHHNP2 (ORCPT + 1 other); Mon, 8 Aug 2016 09:15:28 -0400 Received: from smtp2.goneo.de ([85.220.129.33]:52564 "EHLO smtp2.goneo.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752077AbcHHNPZ (ORCPT ); Mon, 8 Aug 2016 09:15:25 -0400 Received: from localhost (localhost [127.0.0.1]) by smtp2.goneo.de (Postfix) with ESMTP id 51C7C2436D6; Mon, 8 Aug 2016 15:15:22 +0200 (CEST) X-Virus-Scanned: by goneo X-Spam-Flag: NO X-Spam-Score: -2.787 X-Spam-Level: X-Spam-Status: No, score=-2.787 tagged_above=-999 tests=[ALL_TRUSTED=-1, AWL=0.113, BAYES_00=-1.9] autolearn=unavailable Received: from smtp2.goneo.de ([127.0.0.1]) by localhost (smtp2.goneo.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id wk5gioW3SEvw; Mon, 8 Aug 2016 15:15:12 +0200 (CEST) Received: from ubu1604.fritz.box (dyndsl-095-033-000-167.ewe-ip-backbone.de [95.33.0.167]) by smtp2.goneo.de (Postfix) with ESMTPSA id 1E972243877; Mon, 8 Aug 2016 15:15:12 +0200 (CEST) From: Markus Heiser To: Mauro Carvalho Chehab Cc: Markus Heiser , Linux Media Mailing List , linux-doc@vger.kernel.org, Jonathan Corbet , Mauro Carvalho Chehab Subject: [PATCH 2/3] doc-rst: add stand-alone conf.py to media folder Date: Mon, 8 Aug 2016 15:14:59 +0200 Message-Id: <1470662100-6927-3-git-send-email-markus.heiser@darmarit.de> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1470662100-6927-1-git-send-email-markus.heiser@darmarit.de> References: <1470662100-6927-1-git-send-email-markus.heiser@darmarit.de> Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-PMX-Version: 6.0.0.2142326, Antispam-Engine: 2.7.2.2107409, Antispam-Data: 2016.8.8.131217 X-PMX-Spam: Gauge=IIIIIIII, Probability=8%, Report=' MULTIPLE_RCPTS 0.1, HTML_00_01 0.05, HTML_00_10 0.05, BODY_SIZE_5000_5999 0, BODY_SIZE_7000_LESS 0, IN_REP_TO 0, LEGITIMATE_NEGATE 0, LEGITIMATE_SIGNS 0, MSG_THREAD 0, MULTIPLE_REAL_RCPTS 0, REFERENCES 0, URI_ENDS_IN_HTML 0, __ANY_URI 0, __CC_NAME 0, __CC_NAME_DIFF_FROM_ACC 0, __CC_REAL_NAMES 0, __CP_URI_IN_BODY 0, __FROM_DOMAIN_IN_ANY_CC2 0, __FROM_DOMAIN_IN_RCPT 0, __HAS_CC_HDR 0, __HAS_FROM 0, __HAS_MSGID 0, __HAS_X_MAILER 0, __HAS_X_MAILING_LIST 0, __HTTPS_URI 0, __IN_REP_TO 0, __MIME_TEXT_ONLY 0, __MULTIPLE_RCPTS_CC_X2 0, __MULTIPLE_URI_TEXT 0, __REFERENCES 0, __SANE_MSGID 0, __SUBJ_ALPHA_END 0, __TO_MALFORMED_2 0, __TO_NAME 0, __TO_NAME_DIFF_FROM_ACC 0, __TO_REAL_NAMES 0, __URI_IN_BODY 0, __URI_NS , __URI_WITH_PATH 0' From: Markus Heiser With the media/conf.py, the media folder can be build and distributed stand-alone. BTW fixed python indentation in media/conf_nitpick.py. Python indentation is 4 spaces [1] and Python 3 disallows mixing the use of tabs and spaces for indentation. [1] https://www.python.org/dev/peps/pep-0008/#indentation [2] https://www.python.org/dev/peps/pep-0008/#tabs-or-spaces Signed-off-by: Markus Heiser --- Documentation/media/conf.py | 3 + Documentation/media/conf_nitpick.py | 150 +++++++++++++++++++----------------- 2 files changed, 81 insertions(+), 72 deletions(-) create mode 100644 Documentation/media/conf.py diff --git a/Documentation/media/conf.py b/Documentation/media/conf.py new file mode 100644 index 0000000..62bdba2 --- /dev/null +++ b/Documentation/media/conf.py @@ -0,0 +1,3 @@ +# -*- coding: utf-8; mode: python -*- + +project = 'Linux Media Subsystem Documentation' diff --git a/Documentation/media/conf_nitpick.py b/Documentation/media/conf_nitpick.py index 9034d7f..e794e3d 100644 --- a/Documentation/media/conf_nitpick.py +++ b/Documentation/media/conf_nitpick.py @@ -1,4 +1,10 @@ -nitpicky=True +# -*- coding: utf-8; mode: python -*- + +project = 'Linux Media Subsystem Documentation' +# within nit-picking build, do not refer to any intersphinx object +intersphinx_mapping = {} + +nitpicky = True # It is possible to run Sphinx in nickpick mode with: # make SPHINXOPTS=-n htmldocs @@ -10,76 +16,76 @@ nitpicky=True # The list below has a list of such symbols to be ignored in nitpick mode # nitpick_ignore = [ - ("c:func", "clock_gettime"), - ("c:func", "close"), - ("c:func", "container_of"), - ("c:func", "determine_valid_ioctls"), - ("c:func", "ERR_PTR"), - ("c:func", "ioctl"), - ("c:func", "IS_ERR"), - ("c:func", "mmap"), - ("c:func", "open"), - ("c:func", "pci_name"), - ("c:func", "poll"), - ("c:func", "PTR_ERR"), - ("c:func", "read"), - ("c:func", "release"), - ("c:func", "set"), - ("c:func", "struct fd_set"), - ("c:func", "struct pollfd"), - ("c:func", "usb_make_path"), - ("c:func", "write"), - ("c:type", "atomic_t"), - ("c:type", "bool"), - ("c:type", "buf_queue"), - ("c:type", "device"), - ("c:type", "device_driver"), - ("c:type", "device_node"), - ("c:type", "enum"), - ("c:type", "file"), - ("c:type", "i2c_adapter"), - ("c:type", "i2c_board_info"), - ("c:type", "i2c_client"), - ("c:type", "ktime_t"), - ("c:type", "led_classdev_flash"), - ("c:type", "list_head"), - ("c:type", "lock_class_key"), - ("c:type", "module"), - ("c:type", "mutex"), - ("c:type", "pci_dev"), - ("c:type", "pdvbdev"), - ("c:type", "poll_table_struct"), - ("c:type", "s32"), - ("c:type", "s64"), - ("c:type", "sd"), - ("c:type", "spi_board_info"), - ("c:type", "spi_device"), - ("c:type", "spi_master"), - ("c:type", "struct fb_fix_screeninfo"), - ("c:type", "struct pollfd"), - ("c:type", "struct timeval"), - ("c:type", "struct video_capability"), - ("c:type", "u16"), - ("c:type", "u32"), - ("c:type", "u64"), - ("c:type", "u8"), - ("c:type", "union"), - ("c:type", "usb_device"), + ("c:func", "clock_gettime"), + ("c:func", "close"), + ("c:func", "container_of"), + ("c:func", "determine_valid_ioctls"), + ("c:func", "ERR_PTR"), + ("c:func", "ioctl"), + ("c:func", "IS_ERR"), + ("c:func", "mmap"), + ("c:func", "open"), + ("c:func", "pci_name"), + ("c:func", "poll"), + ("c:func", "PTR_ERR"), + ("c:func", "read"), + ("c:func", "release"), + ("c:func", "set"), + ("c:func", "struct fd_set"), + ("c:func", "struct pollfd"), + ("c:func", "usb_make_path"), + ("c:func", "write"), + ("c:type", "atomic_t"), + ("c:type", "bool"), + ("c:type", "buf_queue"), + ("c:type", "device"), + ("c:type", "device_driver"), + ("c:type", "device_node"), + ("c:type", "enum"), + ("c:type", "file"), + ("c:type", "i2c_adapter"), + ("c:type", "i2c_board_info"), + ("c:type", "i2c_client"), + ("c:type", "ktime_t"), + ("c:type", "led_classdev_flash"), + ("c:type", "list_head"), + ("c:type", "lock_class_key"), + ("c:type", "module"), + ("c:type", "mutex"), + ("c:type", "pci_dev"), + ("c:type", "pdvbdev"), + ("c:type", "poll_table_struct"), + ("c:type", "s32"), + ("c:type", "s64"), + ("c:type", "sd"), + ("c:type", "spi_board_info"), + ("c:type", "spi_device"), + ("c:type", "spi_master"), + ("c:type", "struct fb_fix_screeninfo"), + ("c:type", "struct pollfd"), + ("c:type", "struct timeval"), + ("c:type", "struct video_capability"), + ("c:type", "u16"), + ("c:type", "u32"), + ("c:type", "u64"), + ("c:type", "u8"), + ("c:type", "union"), + ("c:type", "usb_device"), - ("cpp:type", "boolean"), - ("cpp:type", "fd"), - ("cpp:type", "fd_set"), - ("cpp:type", "int16_t"), - ("cpp:type", "NULL"), - ("cpp:type", "off_t"), - ("cpp:type", "pollfd"), - ("cpp:type", "size_t"), - ("cpp:type", "ssize_t"), - ("cpp:type", "timeval"), - ("cpp:type", "__u16"), - ("cpp:type", "__u32"), - ("cpp:type", "__u64"), - ("cpp:type", "uint16_t"), - ("cpp:type", "uint32_t"), - ("cpp:type", "video_system_t"), + ("cpp:type", "boolean"), + ("cpp:type", "fd"), + ("cpp:type", "fd_set"), + ("cpp:type", "int16_t"), + ("cpp:type", "NULL"), + ("cpp:type", "off_t"), + ("cpp:type", "pollfd"), + ("cpp:type", "size_t"), + ("cpp:type", "ssize_t"), + ("cpp:type", "timeval"), + ("cpp:type", "__u16"), + ("cpp:type", "__u32"), + ("cpp:type", "__u64"), + ("cpp:type", "uint16_t"), + ("cpp:type", "uint32_t"), + ("cpp:type", "video_system_t"), ]