Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a simple description on how to add a new platform #176

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

KanjiMonster
Copy link
Contributor

Add a small manual on how to add support for a new platform, under the assumption that the platform is supported by ONL and SONIC.

@KanjiMonster KanjiMonster requested review from jklare and ideaship May 12, 2023 12:49
Copy link
Contributor

@hilmarm hilmarm left a comment

Choose a reason for hiding this comment

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

Just a few wording suggestions. I will try the guide next to see if I can add a platform myself

developer_guide.md Outdated Show resolved Hide resolved

## Adding new platform support

To add support for a plaform, there are three places that need to be changed:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To add support for a plaform, there are three places that need to be changed:
To add support for a plaform, changes will have to be made in three places:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You changed the sentence but didn't even fix the "plaform" ;P

Also you didn't notice that it says three changes, but actually lists four.

Anyway, rewrote the sentence to active voice as well.

developer_guide.md Outdated Show resolved Hide resolved
developer_guide.md Show resolved Hide resolved
developer_guide.md Outdated Show resolved Hide resolved
```

Using this, create a new file named `platform.conf`in a directory named like the
ONIE machine name [here](https://github.com/bisdn/meta-switch/tree/main/scripts/installer/machine).
Copy link
Contributor

Choose a reason for hiding this comment

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

So we want platform.conf to be located in ../installer/machine/<ONIE machine name>/platform.conf ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes.

Add a small manual on how to add support for a new platform, under the
assumption that the platform is supported by ONL and SONIC.

Signed-off-by: Jonas Gorski <[email protected]>
* extend the intro, point to Yocto docs
* reword and extend steps
* fix typos
* add testing changes step
* add documenation step
* add pull requests step

Signed-off-by: Jonas Gorski <[email protected]>
Signed-off-by: Jonas Gorski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants