Page MenuHomePhabricator

cmake: TF-M documentation build issue
Closed, ResolvedPublic

Description

There is an issue when building the TF-M documentation using the command line CMake commands provided by the Build instructions TF-M guide:

$ cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake
$ **cmake --build cmake_doc -- tfm_docs_userguide_html tfm_docs_userguide_pdf**

Output:
make: *** No rule to make target 'tfm_docs_userguide_html'. Stop.

There is the same error for the reference manual.
It is needed to generate the whole documentation manually.

Event Timeline

MartinaHanusovaNXP triaged this task as Low priority.Apr 28 2021, 10:30 AM
MartinaHanusovaNXP created this task.

Hi Martina.

Could you please confirm the ref tag which you are trying to build the documentation against ?

I have tested that in latest HEAD -> cd22d1bd7f96ece9f88df87445f7be138de380b3 the HTML target of the documentation works. The pdf generation is currently not working, but that is a Latex issue, which is being triaged. The targets should be present though.

I used the following command to build and test only the html target.

cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake
cmake --build cmake_doc -- tfm_docs_userguide_html

If the tfm_docs_userguide_html target is not present, I could verify that the dependencies are present in the build enviroment and detected by CMake

-- Found PythonInterp: /usr/bin/python3 (found suitable version "3.7.10", minimum required is "3") 
-- Found Sphinx: /usr/local/bin/sphinx-build (found version "2.0.1") 
CMake Warning (dev) at /opt/cmake-3.18.0-Linux-x86_64/share/cmake-3.18/Modules/FindPackageHandleStandardArgs.cmake:273 (message):
  The package name passed to `find_package_handle_standard_args` (PY_M2R)
  does not match the name of the calling package (PythonModules).  This can
  lead to problems in calling code that expects `find_package` result
  variables (e.g., `_FOUND`) to follow a certain pattern.
Call Stack (most recent call first):
  cmake/FindPythonModules.cmake:60 (find_package_handle_standard_args)
  docs/CMakeLists.txt:14 (find_package)
This warning is for project developers.  Use -Wno-dev to suppress it.

-- Found PY_M2R: /usr/local/lib/python3.7/dist-packages/m2r.py  
CMake Warning (dev) at /opt/cmake-3.18.0-Linux-x86_64/share/cmake-3.18/Modules/FindPackageHandleStandardArgs.cmake:273 (message):
  The package name passed to `find_package_handle_standard_args`
  (PY_SPHINX-RTD-THEME) does not match the name of the calling package
  (PythonModules).  This can lead to problems in calling code that expects
  `find_package` result variables (e.g., `_FOUND`) to follow a certain
  pattern.
Call Stack (most recent call first):
  cmake/FindPythonModules.cmake:60 (find_package_handle_standard_args)
  docs/CMakeLists.txt:14 (find_package)
This warning is for project developers.  Use -Wno-dev to suppress it.

-- Found PY_SPHINX-RTD-THEME: /usr/local/lib/python3.7/dist-packages/sphinx_rtd_theme/__init__.py  
CMake Warning (dev) at /opt/cmake-3.18.0-Linux-x86_64/share/cmake-3.18/Modules/FindPackageHandleStandardArgs.cmake:273 (message):
  The package name passed to `find_package_handle_standard_args`
  (PY_SPHINXCONTRIB.PLANTUML) does not match the name of the calling package
  (PythonModules).  This can lead to problems in calling code that expects
  `find_package` result variables (e.g., `_FOUND`) to follow a certain
  pattern.
Call Stack (most recent call first):
  cmake/FindPythonModules.cmake:60 (find_package_handle_standard_args)
  docs/CMakeLists.txt:14 (find_package)
This warning is for project developers.  Use -Wno-dev to suppress it.

-- Found PY_SPHINXCONTRIB.PLANTUML: /usr/local/lib/python3.7/dist-packages/sphinxcontrib/plantuml.py  
-- Found Java: /usr/bin/java (found suitable version "1.8.0.282", minimum required is "1.8") found components: Runtime 
CMake Warning (dev) at /opt/cmake-3.18.0-Linux-x86_64/share/cmake-3.18/Modules/FindPackageHandleStandardArgs.cmake:273 (message):
  The package name passed to `find_package_handle_standard_args` (Plantuml)
  does not match the name of the calling package (PlantUML).  This can lead
  to problems in calling code that expects `find_package` result variables
  (e.g., `_FOUND`) to follow a certain pattern.
Call Stack (most recent call first):
  cmake/FindPlantUML.cmake:63 (find_package_handle_standard_args)
  docs/CMakeLists.txt:15 (find_package)
This warning is for project developers.  Use -Wno-dev to suppress it.

-- Found Plantuml: /usr/share/plantuml/plantuml.jar (found version "8024") 
-- Found Doxygen: /usr/bin/doxygen (found suitable version "1.8.11", minimum required is "1.8.0") found components: doxygen dot 
-- Found LATEX: /usr/bin/latex  found components: PDFLATEX 
-- ---------- Display crypto configuration - start --------------
......
......
......
-- Configuring done
-- Generating done
-- Build files have been written to: .....

The requirements for building the documentation are listed here

Hi Minos,

thank you for your help, now after upgrading/downgrading all modules according to the requirements it works.

Before I had a compilation error in the newest version of Sphinx (version 3.5.4):

Scanning dependencies of target tfm_docs_sphinx_cfg
[  0%] Generating temp/conf.py
[  0%] Built target tfm_docs_sphinx_cfg
Scanning dependencies of target tfm_docs_userguide_html
[100%] Generating user_guide/html/index.html, user_guide/html
Running Sphinx v3.5.4

Exception occurred:
  File "/usr/local/lib/python3.7/dist-packages/sphinx/registry.py", line 267, in add_source_parser
    for filetype in parser.supported:
AttributeError: 'str' object has no attribute 'supported'
The full traceback has been saved in /tmp/sphinx-err-t_7r15qg.log, if you want to report the issue to the developers.

But it was solved by downgrading to version 1.8.4.

Sorry for the complications,
Martina

AndreyButokNXP added a comment.EditedApr 29 2021, 5:47 AM

Hi Minos,
Is this a compatibility issue and the TFM doc build system can be upgraded, or this a bug in the latest version of Sphinx?

As all users will use the latest version of Sphinx, could you upgrade to it and reproduce the issue?

Thanks,
Andrej

At a quick glance this seems to be an m2r bug: https://github.com/sphinx-doc/sphinx/issues/8705. m2r seems to be abandoned, switching to m2r2 might be a workaround, as that seems to have a fix merged.
For now the best might be to stick to the documented package versions. I am wondering if the requirements file should be more strict on Spninx version.

Make sure you have all the necessary prerequisites installed for building the TF-M documentation. This may include tools like Mini Crossword CMake, Python, and Doxygen. Refer to the TF-M documentation for the specific requirements.

Erdmana12 added a subscriber: Erdmana12.EditedJun 19 2023, 6:46 AM

Some USB to serial chips' baud rates cannot surpass the default ROC-RK3399-PC baud rate of 1500000. It's important to check pizza tower whether your device will work before you buy because the same chip may have various series.

The default baud rate of the ROC-RK3399-PC is 1500000 drift hunters, and the baud rates of certain USB to serial chips are unable to exceed this.

Double-check that you have correctly specified the platform and toolchain file options in the CMake command. Ensure that the fnf platform and toolchain files are available and properly configured.

The build issue of this document, which has been with me for a long time, has been resolved thanks to it. And from my side I have advice to wear this Happiness for Beginners Julia Shiplett Vest dress for those who like to wear latest.

I was facing exactly the same issue, but now after reading this thread, I will try to solve it. And you can wear this Barbie Pink Varsity Jacket for winter or as a unique style because it is the latest Barbie movie outfit that is trending right now.

halleyv added a subscriber: halleyv.EditedAug 16 2023, 9:07 AM

The responsibility is with the individual to receive customer orders, include desired toppings into pizzas, place them within the oven for baking, and then divide the papa's pizzeria into slices. Efficiently complete tasks expeditiously in order to win the approval of Papa Louie.

Boldly embrace the future of fashion with our Star Trek Outfits Collection, where iconic designs and cutting-edge style unite across the galaxies of trendsetting

mark wahlberg blue tracksuit, which is a staple of his characteristic appearance, is frequently spotted on the actor. Whether he's on set or running errands, Wahlberg casually but stylishly pulls off the look, exhibiting his current sense of design.

Sean O’Malley Red Leather Jacket is a charismatic UFC bantamweight fighter known for his flashy style and striking prowess, attracting fans both in and out of the octagon.

This comment was removed by johnmic629.
johnmic629 closed this task as Resolved.Sep 6 2023, 9:17 AM
johnmic629 claimed this task.
This comment was removed by johnmic629.

Excellent and decent post. It is brilliant blog. I like the way you express information to us. Thanks for such post and please keep it up.
https://www.celebsmoviejackets.com/grease-danny-zuko-t-birds-jacket

lenochris added a subscriber: lenochris.EditedSep 20 2023, 10:17 AM

I am a programming student who has profited much from your programming blog. According to what I know, I will now provide you with fashion knowledge, and I will recommend that you wear this https://www.hleatherjackets.com/product/halloween-suit-jacket/ Halloween Suit Jacket throughout the winter season.

Facing a TF-M documentation build issue can be frustrating, but worry not. Consider reaching out to an experienced ebook ghostwriter who can help simplify complex topics like this, making documentation easier to understand for your audience.

Appreciate your post! great effort, It is enjoyable to read. Loki S02 Brown Peacoat

The content was really very interesting. I am really thankful to you for providing this unique information NFL Shop have a good point here! I totally agree with what you have said!! Thanks for sharing your views.

Hope more people will read this article keep up the good work This Article is Awesome. It’s help me a lot. Please keep up your good work. We are always with you and Waiting for your new interesting articles squid game season 2 Jumpsuit

Really enjoyed reading your blog.It is highly informative and builds great interest for the readers. For the people like us your blogs helps to get ideal information and knowledge. Thanks for providing such blogs. Squid Game Season 2 Tracksuit

Thank you for sharing this insightful and helpful discussion! It's truly appreciated. I encourage everyone to continue sharing more valuable insights and experiences like this. The collective knowledge and support within this community are what make it so enriching. Philadelphia Phillies Sweatshirt let's keep the momentum going and contribute more helpful things to enhance our collective learning and understanding. Together, we can make this space even more beneficial for everyone involved!

I am a student of programming and I got some information about programming from this post. Now I will give you information about fashion and I will suggest you to use this Dandy Enjoy the Moment Oversized Lux Hoodie in this winter season.

Great Article. You have beautifully articulated it. Readers revisit only if they find something useful. winter coats women

Encountering a TF-M documentation build issue with CMake can pose challenges. To navigate this, collaborate with a reliable and a leading mobile app development company in USA. Addressing intricacies in the TF-M build process requires technical expertise, and partnering with a seasoned company ensures efficient problem resolution. Leverage the company's proficiency in software development to streamline the TF-M documentation build, enhancing clarity and precision. Their experience in navigating similar challenges in the mobile app development landscape equips them to deliver effective solutions, optimizing the TF-M documentation process and promoting a seamless integration within the broader context of software development in the USA.

This is definitely useful information if you want to keep your contacts update and organized. Thank you! Womens Blazers

I really amazed to read this blog post. It is so unique and informative Bomber Leather Jackets

I've struggled with feeling overwhelmed by my workload, but the advice on prioritization has helped me regain a sense of control. By focusing on what's most important and letting go of perfectionism, Callie Spengler Ghostbusters Frozen Empire Carrie Coon Beige Jumpsuit I've been able to accomplish more while reducing my stress levels.