From 86c56299334c46cd95efd72cd4ad6c35f58f16eb Mon Sep 17 00:00:00 2001 From: Samaresh Kumar Singh Date: Mon, 17 Nov 2025 14:20:12 -0600 Subject: [PATCH] Fix tutorial documentation Jamroot/Jamfile references The tutorial was incorrectly stating that the tutorial directory contains a Jamroot file, when it actually contains a Jamfile. The Jamroot is in the parent example directory. This was causing confusion as the link pointed to example/Jamroot but the text suggested it was in the tutorial directory. Updated the documentation to clarify: - The tutorial directory contains hello.cpp, hello.py, and Jamfile - The parent example directory contains the Jamroot template - Made the link description clearer about the file location Fixes #1045 Signed-off-by: Samaresh Kumar Singh --- doc/tutorial.qbk | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/tutorial.qbk b/doc/tutorial.qbk index 197470013..1344710c0 100644 --- a/doc/tutorial.qbk +++ b/doc/tutorial.qbk @@ -101,12 +101,13 @@ The tutorial example can be found in the directory: * hello.cpp * hello.py -* Jamroot +* Jamfile -The [^hello.cpp] file is our C++ hello world example. The [^Jamroot] is -a minimalist ['bjam] script that builds the DLLs for us. Finally, -[^hello.py] is our Python program that uses the extension in -[^hello.cpp]. +The [^hello.cpp] file is our C++ hello world example. The [^Jamfile] is +a ['bjam] script that builds the DLLs for us. The parent directory +[^libs/python/example] also contains a [^Jamroot] file that can be used +as a template. Finally, [^hello.py] is our Python program that uses the +extension in [^hello.cpp]. Before anything else, you should have the bjam executable in your boost directory or somewhere in your path such that [^bjam] can be executed in @@ -117,9 +118,10 @@ platforms. The complete list of Bjam executables can be found [h2 Let's Jam!] __jam__ -[@../example/Jamroot Here] is our minimalist Jamroot -file. Simply copy the file and tweak [^use-project boost] to where your -boost root directory is and you're OK. +[@../example/Jamroot Here] is a minimalist Jamroot +file in the [^libs/python/example] directory. Simply copy the file and tweak +[^use-project boost] to where your boost root directory is and you're OK. +The tutorial directory itself contains a [^Jamfile] that uses this Jamroot. The comments contained in the Jamroot file above should be sufficient to get you going.