From patchwork Sun Sep 3 08:54:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Martin Jansa X-Patchwork-Id: 29893 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 43235C83F3E for ; Sun, 3 Sep 2023 08:55:15 +0000 (UTC) Received: from mail-ed1-f52.google.com (mail-ed1-f52.google.com [209.85.208.52]) by mx.groups.io with SMTP id smtpd.web11.24495.1693731310772943735 for ; Sun, 03 Sep 2023 01:55:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20221208 header.b=pljBTjTw; spf=pass (domain: gmail.com, ip: 209.85.208.52, mailfrom: martin.jansa@gmail.com) Received: by mail-ed1-f52.google.com with SMTP id 4fb4d7f45d1cf-5280ef23593so497808a12.3 for ; Sun, 03 Sep 2023 01:55:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1693731309; x=1694336109; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=2hWwqtHp6N5kbh8Ll0qDqXk2duiSHmp2KdTJzx3CMII=; b=pljBTjTwzx98x8keYCSK+9Hcz1SUROC8phNYCsp0xav7WSs9TuncshySHsKM7bFLl4 /gFUcXAbvtK+rC54iSpWmh7yMl0eV5VBimqNIQYBFfzA8r0SADuSSbfHjuv/DumcSAWT 12LD2kVuoRXJ8AtG1klIctWp3hLnNSf8rN++djXiz1Dtb2T8ng/SIyeiBgzfpC9YX184 PxElXzHuOMA+iUcakfzgrtFydDZqrcuaHzoq0lxW0iP5nQzt+VtrP5N17jsTLPKQzd6v 0x0lOcMKCzFOEFPN2CPZBbxS7d+Ne1BUEARu0P8c0pbyvsfwXsSCpzfu6xdawt4qr3mB CnQQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693731309; x=1694336109; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=2hWwqtHp6N5kbh8Ll0qDqXk2duiSHmp2KdTJzx3CMII=; b=BcbavR6MHP4E7o/dUQQ1AnsE1bvLOV4k6U7S55cn8q2Bud5sWwTBWgri6ri1gek+wO nls+Grsj84NRvJ78GNBcb4hVMBa6xa/KTzxpkTcNrpmDder48stDuuAisgOIvaCU72za Q7dev8DMtOJEm2Wsu8KRSrTGZYUhRyVMXRz8zbu4hM+GRcpa47B+mt3UwjE/DSZU6MLh tZvn5hINUuD2wHGkBMK1+ElGb4Is898E1bEre44l6Cm4i1NwJR0zurBYKpeP4lHsN0uE bhBruSSF/UYGW+9IXoPZdDD1HLSxMTy/kjvL4xqz7l5lxjD1D8JMjA0EvRzL6T39sqIG TKAA== X-Gm-Message-State: AOJu0YzaqpTC8UNfemCQygnikJvY96D1QuJRXUyDaNEs9wLMudRl2NgK 7v7x0R4VmenkHjnmR5sS/rozq1EcCQ8= X-Google-Smtp-Source: AGHT+IGdAsJRqVersfMFoX+onG0odqCDBXhsAoePZQwi8dfvNOIuqDBUfu15uSa9YbnLVJBYqZnZuQ== X-Received: by 2002:a05:6402:1f86:b0:52c:9f89:4445 with SMTP id c6-20020a0564021f8600b0052c9f894445mr1705951edc.21.1693731308805; Sun, 03 Sep 2023 01:55:08 -0700 (PDT) Received: from localhost (ip-109-238-218-228.aim-net.cz. [109.238.218.228]) by smtp.gmail.com with ESMTPSA id n10-20020aa7c44a000000b0052a3edff5c3sm4270171edr.87.2023.09.03.01.55.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 03 Sep 2023 01:55:08 -0700 (PDT) From: Martin Jansa X-Google-Original-From: Martin Jansa To: poky@lists.yoctoproject.org Cc: Martin Jansa Subject: [PATCH 1/2] Makefile: remove from top-level directory Date: Sun, 3 Sep 2023 10:54:42 +0200 Message-ID: <20230903085443.684963-1-Martin.Jansa@gmail.com> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Sun, 03 Sep 2023 08:55:15 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/poky/message/13146 * https://git.openembedded.org/bitbake/commit/?id=a7c47f1eac8caac607a2b5f12d07235dff4d740f was somehow badly imported as: just a rename from bitbake/doc/Makefile.sphinx to Makefile: https://git.yoctoproject.org/poky/commit/?id=1fd9c4b2c0ae927df29f7a0d34c3e595bcf48e89 The missing bitbake/doc/Makefile was later restored in: https://git.yoctoproject.org/poky/commit/?id=415962ad94149de121a1c01215073a52bb54dc14 but the doc/README change is still missing in poky Signed-off-by: Martin Jansa --- Makefile | 35 ----------------------------------- bitbake/doc/README | 4 ++-- 2 files changed, 2 insertions(+), 37 deletions(-) delete mode 100644 Makefile diff --git a/Makefile b/Makefile deleted file mode 100644 index c9518558bb8..00000000000 --- a/Makefile +++ /dev/null @@ -1,35 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build -DESTDIR = final - -ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0) -$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed") -endif - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile.sphinx clean publish - -publish: Makefile.sphinx html singlehtml - rm -rf $(BUILDDIR)/$(DESTDIR)/ - mkdir -p $(BUILDDIR)/$(DESTDIR)/ - cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ - cp $(BUILDDIR)/singlehtml/index.html $(BUILDDIR)/$(DESTDIR)/singleindex.html - sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html - -clean: - @rm -rf $(BUILDDIR) - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile.sphinx - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/bitbake/doc/README b/bitbake/doc/README index cdbb23776ee..d4f56afa37c 100644 --- a/bitbake/doc/README +++ b/bitbake/doc/README @@ -47,8 +47,8 @@ To install all required packages run: To build the documentation locally, run: - $ cd documentation - $ make -f Makefile.sphinx html + $ cd doc + $ make html The resulting HTML index page will be _build/html/index.html, and you can browse your own copy of the locally generated documentation with From patchwork Sun Sep 3 08:54:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Martin Jansa X-Patchwork-Id: 29894 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3F0B9C83F2C for ; Sun, 3 Sep 2023 08:55:15 +0000 (UTC) Received: from mail-ej1-f48.google.com (mail-ej1-f48.google.com [209.85.218.48]) by mx.groups.io with SMTP id smtpd.web10.24534.1693731311549212859 for ; Sun, 03 Sep 2023 01:55:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20221208 header.b=PZSaaxD3; spf=pass (domain: gmail.com, ip: 209.85.218.48, mailfrom: martin.jansa@gmail.com) Received: by mail-ej1-f48.google.com with SMTP id a640c23a62f3a-977e0fbd742so67797466b.2 for ; Sun, 03 Sep 2023 01:55:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1693731310; x=1694336110; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=HBm+On0kWLyB9+MJInXm7GszSINYL1e+XGA/6L/3sBA=; b=PZSaaxD3ADvzXEAAlZ45tfeqD0txlg/BAMxVZ924/2sBeSzgGCEruTPIDIkMO6orOY wxFZwalXeDAsbZY/cQP9BtnRHN1t9lO5R+h1HFREsTaYjo20iXjZCfPFszGJJWHaho5w 6cXO8e2SsCjNWyFA6PxJADbSE7hWcDCm6JnuXieeqmA6vVaIzj9HV3FRZSp2dgkBG3S0 ElyX7aZ8UatPUhMjGgmL80Z46j35fDLaRigtFz4TEFTTSBA+E6uDpaes1SYCk+WAq9uA /HtB004UPwg/6TY53eSK2g4djhVLjkRaIJqOMFXrRzdqYMy+1HXSb1e221atztp3FgPp UNnQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693731310; x=1694336110; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HBm+On0kWLyB9+MJInXm7GszSINYL1e+XGA/6L/3sBA=; b=jbU6dF2ZHJTXQpjyfnEcpfSh8MxiLRB171hBe3LSSv8qWbwkvrHwG/ZzWYmmeUwwnD xNzFKkQahpjhFYJK+EMiszu1VipwflYaCzz5p8+knY49oz45USeXxH8CJ9b/I2RdMXUO YZu9mTO36rhNFm/lwr4YJx6ocn6tfzFE2XvZswf0GSOhsUKkhol0gGjDN1rMbxnc4n5P VXoXtluc2LjBsTFEMD6zlY8merbgC/lLx5I+Oxfdlto+eMv/MfgD1BpXXc7sJsQ5BGVp JU22auOyyh72APuzbHAeDoVK8RK1tMvbvM7+3bxT6wuHr6E6iUDtS74L9g8VX0Klmfci H6ZA== X-Gm-Message-State: AOJu0Yz+or35vfKtSFJvDWJvIH14zdAVXyjMwnob1nDxja4W1Hx3XQ73 mB6w/rLj8vN+S88ppZuTA4FF3fAYL4g= X-Google-Smtp-Source: AGHT+IE6OnS6hqKuMjoCTPwkK5b5nQGyHEF+oInG2dLBlyjlIN+BfOb/YVrzL//YxAG7PO2kpSCJjQ== X-Received: by 2002:a17:906:224a:b0:9a2:40e:2cb6 with SMTP id 10-20020a170906224a00b009a2040e2cb6mr5338007ejr.59.1693731309543; Sun, 03 Sep 2023 01:55:09 -0700 (PDT) Received: from localhost (ip-109-238-218-228.aim-net.cz. [109.238.218.228]) by smtp.gmail.com with ESMTPSA id kt8-20020a170906aac800b0099cb1a2cab0sm4542031ejb.28.2023.09.03.01.55.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 03 Sep 2023 01:55:09 -0700 (PDT) From: Martin Jansa X-Google-Original-From: Martin Jansa To: poky@lists.yoctoproject.org Cc: Michael Opdenacker , Richard Purdie , Martin Jansa Subject: [PATCH 2/2] README: update/fix contribution guidelines Date: Sun, 3 Sep 2023 10:54:43 +0200 Message-ID: <20230903085443.684963-2-Martin.Jansa@gmail.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20230903085443.684963-1-Martin.Jansa@gmail.com> References: <20230903085443.684963-1-Martin.Jansa@gmail.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Sun, 03 Sep 2023 08:55:15 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/poky/message/13147 From: Michael Opdenacker - Ask to CC the docs@lists.yoctoproject.org mailing list - doc/README: fix the command to generate the manual (Bitbake rev: 8332664f9141d2c12f70589ebd2eed7eeddd8f77) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie Signed-off-by: Martin Jansa --- bitbake/README | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/bitbake/README b/bitbake/README index 56d6876876c..38a461f5c91 100644 --- a/bitbake/README +++ b/bitbake/README @@ -26,6 +26,11 @@ The git command to do that would be: git send-email -M -1 --to bitbake-devel@lists.openembedded.org +If you're sending a patch related to the BitBake manual, make sure you copy +the Yocto Project documentation mailing list: + + git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org + Mailing list: https://lists.openembedded.org/g/bitbake-devel