Skip to content

Slightly simplify the networking README_NATIVE.md install steps #376

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.

Sign up for GitHub

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

Jump to bottom
Open
jfingerh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Slightly simplify the networking README_NATIVE.md install steps #376

jfingerh wants to merge 1 commit into from

Conversation

@jfingerh
Copy link

@jfingerh jfingerh commented Feb 10, 2023

plus some minor typo corrections.

@jfingerh
Copy link
Author

jfingerh commented Feb 10, 2023

Notes on the changes:

As far as I can see, there is no variable named SCRIPT_DIR in any of the bash scripts in the ipdk/build/networking directory and its subdirectories. Thus it has no effect at all assigning a value to SCRIPT_DIR while running the install script.

It seems to me unnecessarily confusing to give instructions to clone the ipdk repo anywhere you want, and call it <CLONE-PATH>, and then the very first example of how to run the install script only works if you did it in the /git directory. It seems much less confusing to omit that option, and simply always use the -d <CLONE-PATH> in all choices shown. One less thing to get wrong for the reader.

@jfingerh jfingerh mentioned this pull request Feb 10, 2023
Open
@ffoulkes ffoulkes requested review from 5abeel and n-sandeep December 4, 2023 17:16
@ffoulkes
Copy link
Contributor

ffoulkes commented Dec 4, 2023

@n-sandeep @5abeel
Can I get your feedback / approval / disapproval for this PR?

ffoulkes
ffoulkes reviewed Jul 15, 2024
View reviewed changes
build/networking/README_NATIVE.md

```bash
root@linux:~# SCRIPT_DIR=<CLONE-PATH>/ipdk/build/networking/scripts <CLONE-PATH>/ipdk/build/networking/scripts/host_install.sh
root@linux:~# <CLONE-PATH>/ipdk/build/networking/scripts/host_install.sh -d <CLONE-PATH>
Copy link
Contributor

@ffoulkes ffoulkes Jul 15, 2024

Choose a reason for hiding this comment

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

I think this is a typo for SCRIPTS_DIR, which is referenced in host_install.sh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ffoulkes ffoulkes ffoulkes left review comments

@n-sandeep n-sandeep Awaiting requested review from n-sandeep

@5abeel 5abeel Awaiting requested review from 5abeel

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jfingerh @ffoulkes