All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/2] Makefile: remove from top-level directory
@ 2023-09-03  8:54 Martin Jansa
  2023-09-03  8:54 ` [PATCH 2/2] README: update/fix contribution guidelines Martin Jansa
  0 siblings, 1 reply; 2+ messages in thread
From: Martin Jansa @ 2023-09-03  8:54 UTC (permalink / raw)
  To: poky; +Cc: Martin Jansa

* 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 <Martin.Jansa@gmail.com>
---
 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
-- 
2.42.0



^ permalink raw reply related	[flat|nested] 2+ messages in thread

* [PATCH 2/2] README: update/fix contribution guidelines
  2023-09-03  8:54 [PATCH 1/2] Makefile: remove from top-level directory Martin Jansa
@ 2023-09-03  8:54 ` Martin Jansa
  0 siblings, 0 replies; 2+ messages in thread
From: Martin Jansa @ 2023-09-03  8:54 UTC (permalink / raw)
  To: poky; +Cc: Michael Opdenacker, Richard Purdie, Martin Jansa

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

- 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 <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
---
 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
-- 
2.42.0



^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-09-03  8:55 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-03  8:54 [PATCH 1/2] Makefile: remove from top-level directory Martin Jansa
2023-09-03  8:54 ` [PATCH 2/2] README: update/fix contribution guidelines Martin Jansa

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.