docs: Improve Linux cmake getting started documentation (IDFGH-1020) #3347
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Whilst I was going through the new cmake getting started guide, I think I encountered two minor imperfections in the documentation.
Python2 usage
Firstly, if the default
python
command defaults to version 3 instead of 2, the guide recommends to runidf.py
with the olderpython2
interpreter. But the the way it was suggested will not work, since theidf.py
script can not be passed as an argument to thepython2
interpreter but its path must then be used.In this commit, I used a nested
which
command to find the path.Discrepancy pip usage
In step 4 of the getting the started,
pip
is used to install therequirements.txt
file. In the Ubuntu/Debian prerequisite package listpip
is included, but in the Arch version it is not. It seems to make sense to add it to the Arch package list as well. (Even though imho it would make more sense to remove step 4 and do not usepip
to install the packages again for a specific user)