Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 317B4C433EF for ; Fri, 12 Nov 2021 21:18:15 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 167C060E52 for ; Fri, 12 Nov 2021 21:18:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232183AbhKLVVF (ORCPT ); Fri, 12 Nov 2021 16:21:05 -0500 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:52943 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235706AbhKLVVE (ORCPT ); Fri, 12 Nov 2021 16:21:04 -0500 Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id D3B955C02AF; Fri, 12 Nov 2021 16:18:12 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Fri, 12 Nov 2021 16:18:12 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=dtucker.co.uk; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; s=fm1; bh=+CRPAJdAc3bRjhgjv3UnsZhqxv /TCIhH9BX7uofsml4=; b=yqZiOU6Ez+vZYcJ1DhEHJ+O6IuC2xEOQQgj4nDOQnG rIOINW3BqXoUQ7Yae+k9LEho7N5+UG3kLrVag5pfbeh/NHOWdboNWo9MxHrAZVyo 4iEEBSH+l36yPZixenJcXY4aF5wlbIqlYp8zZPEeM5smXAnFMcxZ1Etdogk8Djbe JAu3fpFQ1kuf5u0fsVc1k+evVe/mhSFd4ILscjZ1pHbDRK7+zBgNIAb+2UNsb68H 1RyG9PE/gt5LhnEmTkt+Tjo1cvZ59kSheVfx4bs9fGx9lN5zcoGQBHtL7YHFYug6 P4xJ3nSlE0JCxZsXZqesnq3NNyhZYJ4s8OM/v83BvuEw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :message-id:mime-version:subject:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=+CRPAJdAc3bRjhgjv 3UnsZhqxv/TCIhH9BX7uofsml4=; b=kES2smRf3C0TNqWNf9jCsOiztlAxtLvVa cIcRxAG16jafkec5raqjeoKFNrI7oXg6Cx1IisfUs5/joQ/hLy2Xt1nwTM14XjG6 9AkXPzaVKI/lJCUzElvMpbAeQ+xPig0wMVOIAFf87RrXDl/QzQZFoSZc4QohhDCm DKDwTBETL+9jHMa9iIzQBVggTlfkn6qRu5lzrPSpgJFNAY/BeqjcK/m0NCHw5emh cv1WCpzPQmFGJZLS9qe4WrGYj1vd+XDb4TuQhktit5qa1JpkREtbgzsL4b9/ARbv AztvGh+RKEaS0i2EVs91UNwZl2dHJIDI6ExVu7qkzE2YcXlwH2ZBw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvuddrvdefgddugeegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpefhvffufffkofgggfestdekredtre dttdenucfhrhhomhepffgrvhgvucfvuhgtkhgvrhcuoegurghvvgesughtuhgtkhgvrhdr tghordhukheqnecuggftrfgrthhtvghrnhepfedvtdeuleefhfeutdfgveefhfegvdekge dutedvgfeukeduheetgfehhfekuddunecuvehluhhsthgvrhfuihiivgeptdenucfrrghr rghmpehmrghilhhfrhhomhepuggrvhgvseguthhutghkvghrrdgtohdruhhk X-ME-Proxy: Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 12 Nov 2021 16:18:11 -0500 (EST) From: Dave Tucker To: bpf@vger.kernel.org Cc: corbet@lwn.net, ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org, kafai@fb.com, songliubraving@fb.com, john.fastabend@gmail.com, kpsingh@kernel.org, Dave Tucker Subject: [PATCH bpf-next 0/3] Fix Navigation Issues in Docs Date: Fri, 12 Nov 2021 21:17:21 +0000 Message-Id: X-Mailer: git-send-email 2.33.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: bpf@vger.kernel.org This patch set fixes a couple of documentation issues that was causing some strange behaviour when the sidebar was rendered in the HTML docs. 1. The underlines in the BTF document weren't following the docs guidelines, which I believe caused an issue rendering the TOC with my other patches applied 2. Mixing the Sphix toctree with named sections was causing name stutter in the sidebar navigation. For example: | BPF Type Format | - BPF Type Format 3. The libbpf API documentation wasn't referenced in a toctree It also renames bpf_lsm.rst to prog_lsm.rst such that documentation for program types can be included in the toctree via glob for prog_* Dave Tucker (3): docs: change underline in btf to match style guide docs: Rename bpf_lsm.rst to prog_lsm.rst docs: fix ordering of bpf documentation Documentation/bpf/btf.rst | 44 ++++----- Documentation/bpf/faq.rst | 11 +++ Documentation/bpf/helpers.rst | 7 ++ Documentation/bpf/index.rst | 97 +++---------------- Documentation/bpf/libbpf/index.rst | 4 +- Documentation/bpf/maps.rst | 9 ++ Documentation/bpf/other.rst | 9 ++ .../bpf/{bpf_lsm.rst => prog_lsm.rst} | 0 Documentation/bpf/programs.rst | 9 ++ Documentation/bpf/syscall_api.rst | 11 +++ Documentation/bpf/test_debug.rst | 9 ++ MAINTAINERS | 2 +- 12 files changed, 103 insertions(+), 109 deletions(-) create mode 100644 Documentation/bpf/faq.rst create mode 100644 Documentation/bpf/helpers.rst create mode 100644 Documentation/bpf/maps.rst create mode 100644 Documentation/bpf/other.rst rename Documentation/bpf/{bpf_lsm.rst => prog_lsm.rst} (100%) create mode 100644 Documentation/bpf/programs.rst create mode 100644 Documentation/bpf/syscall_api.rst create mode 100644 Documentation/bpf/test_debug.rst -- 2.33.1