5 Commits

Include renames

Author	SHA1	Message	Date
Cheng Li	f0b40514f8	[docs] do not tell users to delete /usr/bin/python3 ... Section 3.2.1 of the QEMU (Ubuntu) quick start instructs the reader to run "sudo rm -rf /usr/bin/python3" and re-create the symlink by hand. On Debian and Ubuntu, apt and much of the system tooling are Python programs resolved through that path, so following the guide leaves the machine unable to install packages at all - including the packages needed to undo it. The hardcoded 3.9 version in the example also goes stale with every release. Replace it with python-is-python3, which is what provides the python command on these distributions, and add a warning against the manual approach. Drop the now unreferenced screenshot.	2026-09-21 09:52:58 +08:00
Cheng Li	2613055c4a	[docs] point QEMU Linux quick start at qemu-nographic.sh ... The quick start only ever mentions ./qemu.sh, and its file table omits the qemu-nographic scripts entirely. qemu.sh passes -serial stdio without -nographic, so QEMU opens a GTK window for the emulated CLCD. On a headless machine or over SSH it stops at "gtk initialization failed", with nothing in the guide explaining what to do next, even though the BSP already ships qemu-nographic.sh for exactly this case. Add both nographic scripts to the file table and document them where the project is first run.	2026-09-21 09:52:06 +08:00
Cheng Li	4f95e33270	[docs] fix outdated and missing apt packages in QEMU Linux quick start ... The dependency list in the QEMU (Ubuntu) quick start no longer works on current Debian/Ubuntu releases: - gdb-arm-none-eabi no longer exists (dropped since Debian 11 / Ubuntu 22.04); gdb-multiarch replaces it - the qemu meta-package has been split up and can no longer be installed - libncurses5-dev has been removed; libncurses-dev replaces it - libstdc++-arm-none-eabi-newlib was missing, so linking fails with "cannot find -lsupc++", which does not point at the missing package - kconfiglib was not mentioned at all, although scons --menuconfig needs it; python3-kconfiglib is packaged, and pip install kconfiglib is rejected by PEP 668 on recent releases Merge the eleven single-package commands into one, add a table mapping the old package names to the current ones, and note the kconfiglib requirement where menuconfig is first used. Verified with apt-get -s install on Debian 13.	2026-09-11 13:23:29 +08:00
Chen Wang	f6f7d91a61	doxygen: add prefix for page name (#9989) ... Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-13 23:28:19 +08:00
Chen WangandSupper Thomas	40f3b6a569	doxygen: create framework to unify markdown and source code part (#9946) ... * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>	2025-01-26 11:44:39 +08:00