From patchwork Mon Aug 10 21:53:30 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708223 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 64A54138C for ; Mon, 10 Aug 2020 21:54:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 43E0A206B5 for ; Mon, 10 Aug 2020 21:54:44 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lqAMbnD9" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726563AbgHJVyn (ORCPT ); Mon, 10 Aug 2020 17:54:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39174 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726517AbgHJVym (ORCPT ); Mon, 10 Aug 2020 17:54:42 -0400 Received: from mail-ed1-x543.google.com (mail-ed1-x543.google.com [IPv6:2a00:1450:4864:20::543]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 34386C061756 for ; Mon, 10 Aug 2020 14:54:42 -0700 (PDT) Received: by mail-ed1-x543.google.com with SMTP id l23so7513598edv.11 for ; Mon, 10 Aug 2020 14:54:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=NORwqAl8vhsQqDRGGWtrgGgmrCJbU6kdYr/O3c6qfs8=; b=lqAMbnD9U21irzhW8Cc4aPwAGR/54ItHY3DcLbo8oplI3MaDcDJfx36mNt8K9kNp99 IXM4l4hDlKc04QhjehzlJc47irIlo0gUrZaIGN3I8Ccxn8YgkV906cPqZdksJZ7zlN8Q rO1r63uYSFmsRDa38DTXBYGEtNXcBmxkHm4nxPeoR+hFJjOAAU88QjvbhycVozAL5A3t En9vr0pjUP3Dz0k8sgGLS14Rmnequl5a0QmUie2xpEJnRzmD1KbFKztAAI7BDDEI58JE bjIEc+wbRu3MOCVuyf6pJYl///f6vkdcQhzHyj/157iJ/gbmevLAD0X0yihkBfQwZHcC KZBA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=NORwqAl8vhsQqDRGGWtrgGgmrCJbU6kdYr/O3c6qfs8=; b=fKUQOHEwwQcqLDF/SrMvQQ/mD9WVRHPh5c3O6njl/6R/FGbJ2JhZBRZp22GCNV+Fym eGDvBx3n+T47Yv05VeLDCU2NRHyV4X+QPZvd4WcLs2AC0R+vqsWfesY9ecEfaG1VDq6w Wa9FCVdwa0sWzwQGuGWtSjl4D1JMpsKcdk68HEuJ+ZDKjW8weqNXUxtEORhzczISVPqF MToIPKCp+RmwL9gwY8B3IJ+Ed/Fr7/NEAgvqc9OXfWPkDuvdW4xoYWw3e5PCJwN4Rz5n QqIrODJ4HdV/22Tvzm+s605NJCszMTQCBNdM+Xjoss6jj4eeq9H7mPL+cC8xe1YiPmBr lcGA== X-Gm-Message-State: AOAM532dkao5teTLaT5cpmioKlMmXNmePi3JowVWGfavglZOi6fBQ/fS B33Zbk9fxb2s3ahkIlNIfmEjQ7/F X-Google-Smtp-Source: ABdhPJy+UuI9b+PrI8TweC7Q/damhzlwCSfm8jxNsLp94HCaUZyDZLidf7vqs1DXHn+2z3wqFX2WSw== X-Received: by 2002:a05:6402:1457:: with SMTP id d23mr23286954edx.149.1597096480659; Mon, 10 Aug 2020 14:54:40 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:40 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 1/7] doc: use a smaller logo in the sidebar Date: Mon, 10 Aug 2020 23:53:30 +0200 Message-Id: <20200810215336.76070-2-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org The logo takes quite a bit height in the sidebar and so pushes the table of content too much at the bottom. Fix this by reducing the logo to 50%. Signed-off-by: Luc Van Oostenryck --- Documentation/conf.py | 8 +++++++- Documentation/sphinx/static/theme_overrides.css | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 89ba3d785c7a..affa907346c0 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -113,7 +113,13 @@ except: # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['sphinx/static'] +html_static_path = ['sphinx/static'] + +html_context = { + 'css_files': [ + '_static/theme_overrides.css', + ], +} # Custom sidebar templates, must be a dictionary that maps document names # to template names. diff --git a/Documentation/sphinx/static/theme_overrides.css b/Documentation/sphinx/static/theme_overrides.css new file mode 100644 index 000000000000..8d6246e4202c --- /dev/null +++ b/Documentation/sphinx/static/theme_overrides.css @@ -0,0 +1,3 @@ +.wy-side-nav-search > a img.logo { + width: 60%; +} From patchwork Mon Aug 10 21:53:31 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708225 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 7D043138C for ; Mon, 10 Aug 2020 21:54:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 643BD20734 for ; Mon, 10 Aug 2020 21:54:45 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="b5pp5Nlb" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726626AbgHJVyp (ORCPT ); Mon, 10 Aug 2020 17:54:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39176 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726615AbgHJVyn (ORCPT ); Mon, 10 Aug 2020 17:54:43 -0400 Received: from mail-ej1-x644.google.com (mail-ej1-x644.google.com [IPv6:2a00:1450:4864:20::644]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 76930C061787 for ; Mon, 10 Aug 2020 14:54:43 -0700 (PDT) Received: by mail-ej1-x644.google.com with SMTP id f24so10943446ejx.6 for ; Mon, 10 Aug 2020 14:54:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=QNsttxT7Akl/RI+ZvU6cHJ8Ib0z5Axz/sV1pVDMHJaE=; b=b5pp5Nlb2RFHZzoPGlJNlA6n/CYaUIur31+zmqyTLdUXRRAwBl4BkavBm5dr0rG4Cw /OzIqcKYB2KTOGKyv18JE2pO0y4qRmUCaoi3RuQgXlskDeYYQLIxYX+7U4MQdEMrsqa+ DcWqbWu/KkG6LR5PwEJiX3Lv93iUJvZ/X4BcBC8qDivsK6xT4Wv5As0YUfM4HGi3ilwc gqmWCvTGEJ4KK/smmCdXsKPg3rFo/OXvdMrGjRPivjeGKKeHzY0kuYcGDcc1RhiPNEoa kGRB34L6zTbZZCDAZnjSy09NiDIMGf4HquUhvi2a5YlI3B5tkdXJKUDSAbwFt9yOgnKH 5QsQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=QNsttxT7Akl/RI+ZvU6cHJ8Ib0z5Axz/sV1pVDMHJaE=; b=LozJlhOxAFd9ZFRHqA9h7UXW9FIHZbzGs0ROSH7LjmSwoJxWjNrutgtxT3THlZvd3C yi2Zy0i1w2PLvSea2v9Wqo+C0+ruB+5PD57DAYaD2Lagjm+n2J1tl+X/PWOwzImkAOsF Kpl8ETdIk/ZPYdpPXsglSIRQZAZHzYyGC9ZjrmRljC31PIKGSVsFG2NlTKp1X1kwYGIF CZAgNu/0c74Q/bNHlMI+Q6FbNLV8kwaHrMfO+rrGxFIFoU9/7CS3sI0DHRf3WQLocFU1 Oe/vRQxnTXhBj8yVjcQ47sy++VVli85fKPl5C2WIWzPml39pflIEROulR15M80CQ9Zzq BflA== X-Gm-Message-State: AOAM5329Wdmqwnk8i5/QIj2c7BTPlN47Yn5acZs0niODTMq5lU6ZVOqg Y4ZlKDGBofx97K7DzhDgGjxdhHAI X-Google-Smtp-Source: ABdhPJwnxizOfbHA99L0C9C5CYh7NuAGf6k0iUB5I3uIpeSE7VLGq+fNjjflC+rUjzTd8qVZN+rTwg== X-Received: by 2002:a17:906:c1d8:: with SMTP id bw24mr23128617ejb.91.1597096481879; Mon, 10 Aug 2020 14:54:41 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:41 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 2/7] doc: make the sidebar more compact Date: Mon, 10 Aug 2020 23:53:31 +0200 Message-Id: <20200810215336.76070-3-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org There is generous spacing in the sidebar, too generous. So, reduce it to something more compact, which will also allow more entries without scrolling. Signed-off-by: Luc Van Oostenryck --- Documentation/sphinx/static/theme_overrides.css | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/sphinx/static/theme_overrides.css b/Documentation/sphinx/static/theme_overrides.css index 8d6246e4202c..8791046c9013 100644 --- a/Documentation/sphinx/static/theme_overrides.css +++ b/Documentation/sphinx/static/theme_overrides.css @@ -1,3 +1,7 @@ +.wy-menu-vertical a, .wy-menu-vertical li.current > a, .wy-menu-vertical p.caption { + padding: 0.2em 1.2em; +} + .wy-side-nav-search > a img.logo { width: 60%; } From patchwork Mon Aug 10 21:53:32 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708227 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id A749213A4 for ; Mon, 10 Aug 2020 21:54:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8E3032073E for ; Mon, 10 Aug 2020 21:54:45 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="dy5BldRd" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726615AbgHJVyp (ORCPT ); Mon, 10 Aug 2020 17:54:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39184 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726517AbgHJVyo (ORCPT ); Mon, 10 Aug 2020 17:54:44 -0400 Received: from mail-ej1-x643.google.com (mail-ej1-x643.google.com [IPv6:2a00:1450:4864:20::643]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7A2B8C061756 for ; Mon, 10 Aug 2020 14:54:44 -0700 (PDT) Received: by mail-ej1-x643.google.com with SMTP id jp10so10967890ejb.0 for ; Mon, 10 Aug 2020 14:54:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=PewuXJOMmKcFgjGZBeYx8CJJfIZz8m/QKxQ0RGTjPRw=; b=dy5BldRdF89zSOCHHp3Mb+AAhnQxzuhrtKv9GTSY96QZqqh1GLkJiXeKvFKXX1TBz4 oGbJcDGY+TQ7U9mQncgcs4wBwP3KI2LyryhyFWPWCeHja/qHQ5J+Ue3dKNqXHhKISIr/ 4/1jcvN7pzkptFfEt2IbLacOVnccAgHLQnaXPIGgjBRfCw/a0B/BrrA0TBmnTjQHPt++ refSLp4V0mX5KytNQvdo9r6T7ysf0pFOGMLDyt70gOASYkop244KnWbZ6DfZ9BIC6M9y AaqUsHKU6gH+AyCF5g4yH+KuvJOOKva3pYHZSTjQP19bc6Ys8V+KpgWuzRYJp8vappnq RxXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=PewuXJOMmKcFgjGZBeYx8CJJfIZz8m/QKxQ0RGTjPRw=; b=r7zx8QNtgVDfdlNzJESIBh8yDR8LRhPK4ofr96vR30xRJBkJw1plx6L3IUjkvImPOn GzlwbDX9n/2yFmwReHeHkXqxGTssZS7eSZEaHNNu+1KAYRBtSGDEPdEAkg/EN5AaKYxV 9uNL23k4O/GM7X1ZbzZpkSeKv0jnZnlIubwZI90qcciOGMuG0Ofjl18DoV3bksQB4CoX jwMbBhD95k/gMK0xqteJvav9hCCoFTk/H+f+hwkBq8hglmVtwEbvYEWG5BZW5PW6ckvn wYDd17Nz4kwJmMwbJ8ZWE23sbpPAxQEskYQe+pKqJtUKj6/mzEmkjiaHpjI7DHoUN63s OBDg== X-Gm-Message-State: AOAM532XMFKNX+niP57lnUzAisS86qMI0h6FHQdsuF4ni7CxfehNSNYM PcZOxHWrFqYakeiYMxq2mz7RgJx2 X-Google-Smtp-Source: ABdhPJzP8GvJ2+bANXlD6ftS+nKAvuVvdhVlKmvhIX9kyLxs4ODHiNZAGsH3myNgcng5YEV9Kjvatw== X-Received: by 2002:a17:906:6696:: with SMTP id z22mr7677197ejo.159.1597096482984; Mon, 10 Aug 2020 14:54:42 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:42 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 3/7] doc: decrease vertical spacing Date: Mon, 10 Aug 2020 23:53:32 +0200 Message-Id: <20200810215336.76070-4-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org The vertical spacing in the generated HTML is a bit excessive to my taste. So decrease it somehow, especially the top of lists. Signed-off-by: Luc Van Oostenryck --- Documentation/sphinx/static/theme_overrides.css | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Documentation/sphinx/static/theme_overrides.css b/Documentation/sphinx/static/theme_overrides.css index 8791046c9013..3e4bc3b0223a 100644 --- a/Documentation/sphinx/static/theme_overrides.css +++ b/Documentation/sphinx/static/theme_overrides.css @@ -1,3 +1,16 @@ +p { + margin-bottom: 0.6em; +} + +ul.simple { + margin-top: -0.5em; + margin-bottom: 0.5em; +} + +.rst-content .toctree-wrapper ul { + margin-bottom: 0.5em; +} + .wy-menu-vertical a, .wy-menu-vertical li.current > a, .wy-menu-vertical p.caption { padding: 0.2em 1.2em; } From patchwork Mon Aug 10 21:53:33 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708229 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id A6023739 for ; Mon, 10 Aug 2020 21:54:48 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8A41E20734 for ; Mon, 10 Aug 2020 21:54:48 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="XJUnpObW" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726690AbgHJVys (ORCPT ); Mon, 10 Aug 2020 17:54:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39190 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726517AbgHJVyq (ORCPT ); Mon, 10 Aug 2020 17:54:46 -0400 Received: from mail-ej1-x641.google.com (mail-ej1-x641.google.com [IPv6:2a00:1450:4864:20::641]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9104CC061756 for ; Mon, 10 Aug 2020 14:54:45 -0700 (PDT) Received: by mail-ej1-x641.google.com with SMTP id qc22so10934419ejb.4 for ; Mon, 10 Aug 2020 14:54:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=HsYWgjnoCq7jmh/iEc3W3dsbe17gaOmkLeKdtns2fpM=; b=XJUnpObWQZifsSFskaJKflhfOmpn4cXql1KxpsDXo6AzgODz+k9oggD96cJ1k98umD ysIIV/sWnlPl8PGvTmCkBPld6BzbZrfI58rtPQL1zmMRErrGLKZU3pk56Ee94VW7unFE qWVSo4Yce7U9UnljqT5Oqok+P0s7YbsjYa6dpK8F8JtrWBYkwvbfT/dlcwUDLGCczMUM ekfPPJ7TPulHwC8n8vAfTFFyv1PmCERv8j/AiOP8TQjiKLfLShoaoKwwLIzpG+pKog8E oRr7i4Y8nBT3HeqHQ+SWlXKw3QHAiQ9ba6nkRUDTpXU6yfYZP7OQC2l1a1SKZPlhXtJ5 h+Og== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=HsYWgjnoCq7jmh/iEc3W3dsbe17gaOmkLeKdtns2fpM=; b=CH1zUYPZeM8WHqbVwuzvVhJlKlsa2EZakGZK0CniUmTOkDR6TUFJswQTzesWKl6Jvk 4yz0nXHn2ROnA94Qlp0E8eMmPBaRjr2AZkQUzdF5qdKB1Hhk5OuGdOi0RNHh2YJnU7xX T73qFSTbNTxRVeLbdbTc5QmfmI+2NG8kBGtKns+5Ro1d16zoMLt9GnCGPQIPFBscEo1R SoBYv6+RmAVRVLO31eAG9zf6Vnp03RKPLoabjjReB0JKvkFAtlquqENlsj5nI8sS4qmZ /p4EkalFfaAUZ52EHVegBgxmKZatF4JO1x4H2XIBPbGDPV8UFuC7RdStsRbTKosktVqc 3gEw== X-Gm-Message-State: AOAM532J6XzK0CnCM9CGQ8Vo8DisdS7XAH+hYaTxgOcuSJ+uc+cVRCvZ LaUhRXPOIXRpgW+C2QnD7DaLeTKH X-Google-Smtp-Source: ABdhPJyYPALdJgVbdPIKgS9LBqDWD/BvA/LDjwKpwx2QKCVEeE/X2BRNOhH+eCDycNGhZpY/mycGMg== X-Received: by 2002:a17:907:405f:: with SMTP id ns23mr22564401ejb.511.1597096484097; Mon, 10 Aug 2020 14:54:44 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:43 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 4/7] doc: move down info about tarballs, after git repositories Date: Mon, 10 Aug 2020 23:53:33 +0200 Message-Id: <20200810215336.76070-5-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org Better to have the information about the GIT repositories first because I'm not sure if anyone still use the tarballs. Signed-off-by: Luc Van Oostenryck --- Documentation/index.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index 4047343a5a75..321a947ec9c5 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -25,9 +25,6 @@ by Christopher Li in 2009 and by Luc Van Oostenryck in late 2018. Getting Sparse -------------- -You can find tarballs of released versions of Sparse at -https://www.kernel.org/pub/software/devel/sparse/dist/. - The most recent version can be obtained directly from the Git repository with the command:: @@ -35,6 +32,8 @@ repository with the command:: You can also `browse the Git repository `_ or use the mirror at https://github.com/lucvoo/sparse. +The tarballs of released versions of Sparse and their signatures can be found at +https://www.kernel.org/pub/software/devel/sparse/dist/. Once you have the sources, to build Sparse and install it in your ~/bin directory, just do:: From patchwork Mon Aug 10 21:53:34 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708231 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3F0FC138C for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2467D20734 for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="QD7UwhO7" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726697AbgHJVyu (ORCPT ); Mon, 10 Aug 2020 17:54:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39192 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726648AbgHJVyr (ORCPT ); Mon, 10 Aug 2020 17:54:47 -0400 Received: from mail-ej1-x643.google.com (mail-ej1-x643.google.com [IPv6:2a00:1450:4864:20::643]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 85686C061787 for ; Mon, 10 Aug 2020 14:54:46 -0700 (PDT) Received: by mail-ej1-x643.google.com with SMTP id c16so10910899ejx.12 for ; Mon, 10 Aug 2020 14:54:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=O+bRI7gklBgcfuIh8mPjPrpgZq3OU1dsJquvdnGMjdI=; b=QD7UwhO7LLoH8YE5kZ6lxnGbEWrJbg6rpnrY2+B6UJPT1pxKLZG6fnHwR/SZI4j3CO z1emUbXq/6ePGRrxUlhtWDjBaC7EmNb0m95mOu9bnDrdo8IYxiII/t6FU9P/h+3rj5qr Lcc+74Cw7XWAbOmf/3Wctlq2cxv4nzwOC15MBXppqmhk40sm4+MTxYGoUqQHeBTmGi2e HkIVMCp+UIIffDzzxCe9+ASp1FUHXxGHYPyseJsWqZavI3fAEqesB+TVB2RagwaasFv1 o8/xyjuBXmfSmXuq+4eBAOlH6ICTRVDjsS7GZANKdgNkej2IOun7Iu3UAkZpnOd+D7x8 EgzQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=O+bRI7gklBgcfuIh8mPjPrpgZq3OU1dsJquvdnGMjdI=; b=pEGYxUl41QfAixM6FnY5w+TNyv/Y533yYRQhr6/kwB3+yn8kKyPKlEjpOI0lziEGJf /sb+o0VlAoMPYUKwYH0wA9uFLiRRaPpcALWbW/Jr2gLP38tJeVv9XR6cAvC5+O5CndtT ylTzF7LUGFxwtmpHZ53p3lYztWPVhlNEab0aqarAeSB1mvazSapLWkx+jLACjg3UhYIg l4kSAgB5x8hwBeT6OH/y3xDK1hzUJ4AFufDTzTdiogkLCOfw+wd/Z2b+Cj0kForqCDMF o+oa6xasqZ0GBiT4I+jLyABaMWtr0eStAg/+j54DveCLurmrvMil+c6WWdgEdEPUbVxf WQYw== X-Gm-Message-State: AOAM53005Ffp5GBwb1vDquMFPiwp2eQCsoTjhnu0uoAiddDiaSSqQquG z5HMe1LdfogOSJzI1JLX+QcIm2/b X-Google-Smtp-Source: ABdhPJxYixNF6Yi/A95Wdc1TZj14fdamkVnD8HO+FPhpksd5n7IKvxRJp/7c7TcFI9YdnwMbNneXQA== X-Received: by 2002:a17:906:1f8e:: with SMTP id t14mr23966659ejr.336.1597096485005; Mon, 10 Aug 2020 14:54:45 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:44 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 5/7] doc: reorganize the table of content Date: Mon, 10 Aug 2020 23:53:34 +0200 Message-Id: <20200810215336.76070-6-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org Reorganize the table of of content with user documentation first then all documentation useful for development on sparse itself. Signed-off-by: Luc Van Oostenryck --- Documentation/index.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index 321a947ec9c5..4bca8c7e47f3 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -64,22 +64,22 @@ Bugs can also be reported and tracked via the `Linux kernel's bugzilla for spars .. toctree:: - :caption: Documentation + :caption: User Documentation :maxdepth: 1 annotations - dev-options - types - api - IR - test-suite - doc-guide .. toctree:: - :caption: How to contribute + :caption: Development :maxdepth: 1 submitting-patches + types + api + dev-options + IR + test-suite + doc-guide TODO .. toctree:: From patchwork Mon Aug 10 21:53:35 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708233 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 99C4A13A4 for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7D0CA20734 for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="DfG4SoyR" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726648AbgHJVyu (ORCPT ); Mon, 10 Aug 2020 17:54:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39200 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726672AbgHJVys (ORCPT ); Mon, 10 Aug 2020 17:54:48 -0400 Received: from mail-ed1-x542.google.com (mail-ed1-x542.google.com [IPv6:2a00:1450:4864:20::542]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C6A8EC061788 for ; Mon, 10 Aug 2020 14:54:47 -0700 (PDT) Received: by mail-ed1-x542.google.com with SMTP id cq28so7356675edb.10 for ; Mon, 10 Aug 2020 14:54:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=XL/7/tQseOiNjRDRu+/qnW5OAn6SZ1VzTvXL39PHrlQ=; b=DfG4SoyRLh50T5TDTjYcE/RvS3EUhYKxo1mBeIeBQmIy4VpHX1Kl06sutaT2bZhK6k qmR0RFs/cLSBdciKl7vxm5fIexjfrs6pKHQP43g9SwnnJy7hoahG6rFskZjWqLqr7FtE 4DqTWeMwf6SniyPdvvuoJHVCjyDjIWZk43i7540jpzIwnLz+jWeBIDJO7GnpXAQlVfsI m205KTsG+MyJsiIRohuFKaECc70PGFAP1/Q/o3FzPcNfthcHe+fvr1sIS4mMGX0tb6oi u02scRznP3jfKuoM+XicRsXnvGPTSs0yLP63/2vyGBCWiwHilz3eNtsVlHacXSwh6o4k zBGw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=XL/7/tQseOiNjRDRu+/qnW5OAn6SZ1VzTvXL39PHrlQ=; b=CGuvZg+f8w7LZer+KE1yjNV6sfpF6+CYOqDDHLH+lSuY/Fr2LcGumNiZ0+EBtYQXmJ EuuB2Pg/qqTpMUzIbkFHYGxAN9zdNSsHF/YM9+JhpYIZrrn5mBBMgTUbbYGC/1IrLWBh o3FbmfhxLN4fz1S+CdgzW4uHGbiRo7GDJlq5vUnSB63tAZ1WTQtnkcKpZEm+Bo9Fr64r 1AsmBwtUkTC/iAeKkkTT3J+384iDlQtjE4NDaSr98PlPvuWxEMcSu26h+rd5dcqnrB5L M/h4p3hSHFTSvOCB5XMyoOFcut3zRiszZciKXbhfnFEkm1bcwjMkTdW4zRruovNvggVx lG4w== X-Gm-Message-State: AOAM530v6XqlWO4pnHCfOOhr5A9O5EscF7q2yVRsL99eEfyTvecM6HoH kbpgVm7noYqoyZ7P8Ugud27v8PmJ X-Google-Smtp-Source: ABdhPJw5UWHDksbQHU5ojlOTmnI893SJDdAb+jbXGujAvQIsAmCDyCojB8YAEwbuJkncNl6wc/iXMA== X-Received: by 2002:a50:d942:: with SMTP id u2mr15881052edj.0.1597096486363; Mon, 10 Aug 2020 14:54:46 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:45 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 6/7] doc: use shorter titles Date: Mon, 10 Aug 2020 23:53:35 +0200 Message-Id: <20200810215336.76070-7-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org Mainly it's removing 'sparse' from the title. Signed-off-by: Luc Van Oostenryck --- Documentation/IR.rst | 4 ++-- Documentation/dev-options.rst | 4 ++-- Documentation/doc-guide.rst | 4 ++-- Documentation/types.rst | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/IR.rst b/Documentation/IR.rst index 33a761662fad..97d4b2b27ee3 100644 --- a/Documentation/IR.rst +++ b/Documentation/IR.rst @@ -1,7 +1,7 @@ .. default-domain:: ir -Sparse's Intermediate Representation -==================================== +Intermediate Representation +=========================== Instructions ~~~~~~~~~~~~ diff --git a/Documentation/dev-options.rst b/Documentation/dev-options.rst index 23e8096c2cd0..57f9e8d6c4de 100644 --- a/Documentation/dev-options.rst +++ b/Documentation/dev-options.rst @@ -1,5 +1,5 @@ -sparse - extra options for developers -===================================== +Extra options for developers +============================ SYNOPSIS -------- diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst index 8133cb3a59df..29f39aab360a 100644 --- a/Documentation/doc-guide.rst +++ b/Documentation/doc-guide.rst @@ -1,5 +1,5 @@ -How to write sparse documentation -================================= +Documentation guide +=================== Introduction ------------ diff --git a/Documentation/types.rst b/Documentation/types.rst index 272f32a0f4ed..974f9861afef 100644 --- a/Documentation/types.rst +++ b/Documentation/types.rst @@ -1,6 +1,6 @@ -******************** -Sparse's Type System -******************** +*********** +Type System +*********** struct symbol is used to represent symbols & types but most parts pertaining to the types are in the field 'ctype'. From patchwork Mon Aug 10 21:53:36 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luc Van Oostenryck X-Patchwork-Id: 11708235 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id BE4EA739 for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A0CB92073E for ; Mon, 10 Aug 2020 21:54:50 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="nNAjqwRn" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726672AbgHJVyu (ORCPT ); Mon, 10 Aug 2020 17:54:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39202 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726517AbgHJVyt (ORCPT ); Mon, 10 Aug 2020 17:54:49 -0400 Received: from mail-ej1-x641.google.com (mail-ej1-x641.google.com [IPv6:2a00:1450:4864:20::641]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3FF07C061756 for ; Mon, 10 Aug 2020 14:54:49 -0700 (PDT) Received: by mail-ej1-x641.google.com with SMTP id t10so6569313ejs.8 for ; Mon, 10 Aug 2020 14:54:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=xcLQaenjDzUA557DeWm7c4DM2Wv8cl+M43dV4ZUcfeI=; b=nNAjqwRnryyZ+N/uTc4dR9/AdGbpz/y7AB07HNLnz+dUijp9App3tLJeOjyfTRcDGJ nhcgT/VApfezxirSiHFQWg6ESKQC45maw2iKcALuX8oF3YtI3pskTybCI70pesevRlw2 wCjQO3N8BSlgIkYIv40+CbAjJKyqGDT6JJJ4xp+eDAnpQ/Kum4CLAvqpYSimXoi8+8bP 4/B16Mcu1GH5NT+pSj0oXVN87BxuZvKCC7lw8wgsVmhlG/yPqcYWItDZXw59qUvCT3mX vTQfIG7hBtIjR2Wq0DcVoyPGkRTueqyU3TVu7zjcUDS4L+iy4PPrl8ybYKdxVK2HPODT 46mA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=xcLQaenjDzUA557DeWm7c4DM2Wv8cl+M43dV4ZUcfeI=; b=kV/WgGEbGiypQsh/NKu7+tEDmKIZVvQWti3Lm0pLi8m2tfgAiH76GAljty5sf97EVM Z1OZ6ErR3I/Nj3a3aRBSAPe0r4D5ZH3CaJEx/fxB1h2XjF83p/SSlmVjg7pirBkKNCLQ am+2++HyPgRC5ZZTpYsYgaNYUQEZv7J7JCmmGWu+Gaz3OBvj78MmGCqF6FaZbs6n5Anv wtoEG4+SG8+yUUPR1AtyWqTmyfoWftqiPUMGHp6koSgvjzh5RdCWz50qPkSAgiEv8Ll0 wvs05uR6gWwoo4rFX2fJIyu9gdPiFzXSZDw3hCns7UmN5c8XGqTxD8EBNHX+DsNG8urm GULQ== X-Gm-Message-State: AOAM5317o03iSkwvbCOW0PwKFl5VJFMyRWr2FNgkcpcGeXgRCBlH16AH TNSCsg/eZaIEmMpiqyMe/NqHNXek X-Google-Smtp-Source: ABdhPJzRAEN068wlIiXxU8hskkyq5trUWjwlXA1WyBmEkiq7lT3X3ooJ5qqv3B/LDrBoOoCqqqlUCw== X-Received: by 2002:a17:906:7855:: with SMTP id p21mr23493532ejm.492.1597096487727; Mon, 10 Aug 2020 14:54:47 -0700 (PDT) Received: from localhost.localdomain ([2a02:a03f:a7fb:e200:80df:2003:9ede:fcdf]) by smtp.gmail.com with ESMTPSA id p8sm13771777ejx.53.2020.08.10.14.54.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Aug 2020 14:54:47 -0700 (PDT) From: Luc Van Oostenryck To: linux-sparse@vger.kernel.org Cc: Luc Van Oostenryck Subject: [PATCH 7/7] doc: add links to some external doc Date: Mon, 10 Aug 2020 23:53:36 +0200 Message-Id: <20200810215336.76070-8-luc.vanoostenryck@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> References: <20200810215336.76070-1-luc.vanoostenryck@gmail.com> MIME-Version: 1.0 Sender: linux-sparse-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sparse@vger.kernel.org One is a LWN article which covers sparse very well, the other is a pdf giving a short overview of sparse. Signed-off-by: Luc Van Oostenryck --- Documentation/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/index.rst b/Documentation/index.rst index 4bca8c7e47f3..e29a5643849a 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -69,6 +69,11 @@ Bugs can also be reported and tracked via the `Linux kernel's bugzilla for spars annotations +Some interesting external documentation: + +* `Sparse: a look under the hood `_ +* `Sparse: a short overview `_ + .. toctree:: :caption: Development :maxdepth: 1