seL4 / docs

This is the source of the seL4 docs.

Home Page:https://docs.sel4.systems

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Typo error

hugusmaximus opened this issue · comments

I think there's a typo error on the "IA32 Example" where it says:

../init-build.sh -DPLATFORM=ia32 -DRELEASE=TRUE -DSIMULATION=TRUE

should say:

../../init-build.sh -DPLATFORM=ia32 -DRELEASE=TRUE -DSIMULATION=TRUE

It's not a problem at all, but if you are copy-pasting commands it breaks a bit the "magic" of the "user experience" :-)
The more things we can try of seL4, the smoother things work, the more addictive it becomes.

Thanks for reporting that. Is it the example on this page?

If yes, I think I can see where the confusion is coming from. The first set of instructions (under
"Build it") tells you to make a build directory and change into it. The concrete IA32 example further down assumes that you're starting at the same point (i.e. have gone out of build again), and makes its own ia32_build directory. For that, the ../init.sh should be the right path, but if you're still inside build you'd need to go two down. Is that what happened or is it something else?

Not sure what the best way to fix this is. Maybe swapping the order of the examples and being explicit about the directory where things are starting from will do it.

Ok, maybe I'm wrong. I just "blindly" copy-pasted commands and assumed they can be executed sequentially... maybe I got lost a some point...my apologies.

That assumption is perfectly fine (I rarely read all of the text in such cases), we should make it so that that strategy works. I'm just trying to figure out if I'm looking at the correct thing to fix.