Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

add documentation for the Posix shell #600

Merged
merged 6 commits into from
Sep 10, 2018
Merged

Conversation

bkueng
Copy link
Member

@bkueng bkueng commented Sep 6, 2018

Follows from PX4/PX4-Autopilot#10173.

Points to discuss:

  • Should we split en/advanced/system_startup.md into NuttX- & Posix-specific sections/pages?
  • Should we move en/advanced/system_startup.md out of Advanced to e.g. Concepts?

@@ -1,10 +1,38 @@
# System Startup

The PX4 boot is controlled by shell scripts in the [ROMFS/px4fmu_common/init.d](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d) folder.
The PX4 startup is controlled by shell scripts.
On NuttX they reside in the [ROMFS/px4fmu_common/init.d](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d) folder - some of these are also used on Posix (Linux/MacOS). The scripts that are only used on Posix are located in [ROMFS/px4fmu_common/init.d-posix](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d-posix).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed to "used on Posix (Linux/MacOS)" - ie to add the meaning of posix first time it is used. Slightly leaning towards referring this as "Simulation"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good. It's not only simulation, as in future our Linux-based boards (such as RPi) should use that as well.

@hamishwillee
Copy link
Collaborator

@bkueng Great job - certainly this is understandable. I have done a minor subedit.

Should we split en/advanced/system_startup.md into NuttX- & Posix-specific sections/pages?

My gut feeling is yes to separate sections (not pages).

Should we move en/advanced/system_startup.md out of Advanced to e.g. Concepts?

Definitely. In first instance this could be done just by moving the doc in the summary.

Question, is this a pure "new system developer" topic? ie do we need to think about moving this to the developer guide?

Copy link
Member Author

@bkueng bkueng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have done a minor subedit.

Thanks.
I'll split into sections then.

Question, is this a pure "new system developer" topic? ie do we need to think about moving this to the developer guide?

This is the dev-guide :)

@@ -1,10 +1,38 @@
# System Startup

The PX4 boot is controlled by shell scripts in the [ROMFS/px4fmu_common/init.d](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d) folder.
The PX4 startup is controlled by shell scripts.
On NuttX they reside in the [ROMFS/px4fmu_common/init.d](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d) folder - some of these are also used on Posix (Linux/MacOS). The scripts that are only used on Posix are located in [ROMFS/px4fmu_common/init.d-posix](https://github.com/PX4/Firmware/tree/master/ROMFS/px4fmu_common/init.d-posix).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good. It's not only simulation, as in future our Linux-based boards (such as RPi) should use that as well.

Also changed the NuttX boot: driver failures will not lead to an
aborted boot anymore.
@bkueng
Copy link
Member Author

bkueng commented Sep 7, 2018

I did the splitting and moved it to Concepts.
I also changed the NuttX boot: driver failures will not lead to a aborted boot anymore. This was changed a while ago.

@hamishwillee hamishwillee merged commit 6596679 into master Sep 10, 2018
@hamishwillee hamishwillee deleted the posix_shell_docs branch September 10, 2018 00:52
@hamishwillee
Copy link
Collaborator

Looks great thanks Beat.

FYI only I did a minor additional subedit, moved the doc to concepts and created a redirect (decided it is worth it) and copied doc into Korean/Chinese tree (a bit pointless since we're moving to slightly different approach, but hey!).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants