Skip to content

README typos, pin deps for sbp2json in Cargo.lock #812

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

Merged
merged 2 commits into from
Jun 3, 2020
Merged

README typos, pin deps for sbp2json in Cargo.lock #812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04ebc6f
README typos
Jun 1, 2020
b6e307d
Use Cargo.lock from sbp2json when building
Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ sbp_out.*
.build/

# rust
Cargo.lock
/Cargo.lock
Copy link
Contributor

@jbangelo jbangelo Jun 3, 2020

Choose a reason for hiding this comment

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

Is this needed? Aren't you copying the Cargo.lock file into the rust/ sub directory in the benchmark script?

Copy link
Contributor Author

@silverjam silverjam Jun 3, 2020

Choose a reason for hiding this comment

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

There's a top-level Cargo.lock that we need to ignore (I think) so that we don't have a Cargo.lock if libsbp is pulled in as a dependency from git. Then there's a Cargo.lock that's in rust/sbp2json/Cargo.lock that we've checked in to pin deps, this is what gets copied to the benchmark build script's build directory. The benchmark build script is a little misnamed at the moment... since it's used for building the binaries we distribute for Linux, as well as the benchmark process.

/target

python/sbp/_version.py
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ the tools predate the Rust and Python versions, and also includes an `sbp2yaml`
tool as well as a `sbp2prettyjson` tool.

Finally, a Python version of the `sbp2json` tool exists, which is installable
on any platform that support Python via pip, e.g.:
on any platform that supports Python via pip, e.g.:

```
pip3 install sbp
Expand Down Expand Up @@ -123,7 +123,7 @@ You can then make this image operate on your local workspace like this:

Once in the image, simply type `make all` to gererate all the libsbp bindings.

#### Using the prebuilt one from dockerhub
#### Using the prebuilt one from DockerHub

You can also pull a copy from dockerhub (no guarantees on freshness):

Expand Down
Loading