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 sequence diagrams and flesh out TODO notes #1233

Merged
merged 2 commits into from
Sep 28, 2022
Merged

add sequence diagrams and flesh out TODO notes #1233

merged 2 commits into from
Sep 28, 2022

Conversation

spiffcs
Copy link
Contributor

@spiffcs spiffcs commented Sep 28, 2022

Documentation Updates

  • Add missing dependency Golang
  • Reorder basic make commands above output
  • Add sequence diagrams and directory layouts for cmd/ syft/ packages
  • Add small summaries surrounding library design

Signed-off-by: Christopher Phillips [email protected]

@spiffcs spiffcs marked this pull request as ready for review September 28, 2022 16:26
@kzantow
Copy link
Contributor

kzantow commented Sep 28, 2022

Nice update to the docs 👍

@github-actions
Copy link

github-actions bot commented Sep 28, 2022

Benchmark Test Results

Benchmark results from the latest changes vs base branch
name                                                       old time/op    new time/op    delta
ImagePackageCatalogers/alpmdb-cataloger-2                    14.5ms ± 1%    13.7ms ± 2%  -5.77%  (p=0.016 n=4+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2              1.67ms ± 4%    1.62ms ± 1%    ~     (p=0.063 n=5+4)
ImagePackageCatalogers/python-package-cataloger-2            4.15ms ± 1%    3.88ms ± 2%  -6.64%  (p=0.008 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2    1.35ms ± 6%    1.29ms ± 2%  -4.61%  (p=0.016 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         907µs ± 2%     918µs ± 2%    ~     (p=0.222 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                    1.08ms ± 2%    1.10ms ± 2%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/rpm-db-cataloger-2                    1.55ms ± 2%    1.59ms ± 2%  +2.40%  (p=0.032 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      18.3ms ± 1%    17.0ms ± 1%  -7.01%  (p=0.008 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.53ms ± 3%    1.49ms ± 2%    ~     (p=0.056 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2          2.75µs ± 4%    2.75µs ± 3%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/dotnet-deps-cataloger-2               1.69ms ± 3%    1.67ms ± 3%    ~     (p=0.421 n=5+5)
ImagePackageCatalogers/portage-cataloger-2                    861µs ± 4%     874µs ± 2%    ~     (p=0.548 n=5+5)

name                                                       old alloc/op   new alloc/op   delta
ImagePackageCatalogers/alpmdb-cataloger-2                    5.26MB ± 0%    5.26MB ± 0%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2               202kB ± 0%     202kB ± 0%    ~     (p=0.421 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2             945kB ± 0%     946kB ± 0%  +0.07%  (p=0.008 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     214kB ± 0%     214kB ± 0%    ~     (p=1.000 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         158kB ± 0%     158kB ± 0%    ~     (p=1.000 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                     203kB ± 0%     203kB ± 0%    ~     (p=0.841 n=5+5)
ImagePackageCatalogers/rpm-db-cataloger-2                     302kB ± 0%     301kB ± 0%  -0.13%  (p=0.008 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      3.44MB ± 0%    3.44MB ± 0%    ~     (p=0.056 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.25MB ± 0%    1.25MB ± 0%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2            672B ± 0%      672B ± 0%    ~     (all equal)
ImagePackageCatalogers/dotnet-deps-cataloger-2                369kB ± 0%     369kB ± 0%    ~     (p=0.310 n=5+5)
ImagePackageCatalogers/portage-cataloger-2                    136kB ± 0%     136kB ± 0%    ~     (p=0.841 n=5+5)

name                                                       old allocs/op  new allocs/op  delta
ImagePackageCatalogers/alpmdb-cataloger-2                     85.7k ± 0%     85.7k ± 0%  +0.00%  (p=0.024 n=5+5)
ImagePackageCatalogers/ruby-gemspec-cataloger-2               4.25k ± 0%     4.25k ± 0%    ~     (p=0.556 n=5+4)
ImagePackageCatalogers/python-package-cataloger-2             16.6k ± 0%     16.6k ± 0%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     5.53k ± 0%     5.53k ± 0%    ~     (p=0.413 n=4+5)
ImagePackageCatalogers/javascript-package-cataloger-2         3.32k ± 0%     3.32k ± 0%    ~     (p=0.333 n=5+4)
ImagePackageCatalogers/dpkgdb-cataloger-2                     4.60k ± 0%     4.60k ± 0%    ~     (all equal)
ImagePackageCatalogers/rpm-db-cataloger-2                     8.13k ± 0%     8.13k ± 0%    ~     (all equal)
ImagePackageCatalogers/java-cataloger-2                       57.5k ± 0%     57.5k ± 0%    ~     (p=0.238 n=4+5)
ImagePackageCatalogers/apkdb-cataloger-2                      5.43k ± 0%     5.43k ± 0%    ~     (all equal)
ImagePackageCatalogers/go-module-binary-cataloger-2            15.0 ± 0%      15.0 ± 0%    ~     (all equal)
ImagePackageCatalogers/dotnet-deps-cataloger-2                7.27k ± 0%     7.27k ± 0%    ~     (all equal)
ImagePackageCatalogers/portage-cataloger-2                    3.59k ± 0%     3.59k ± 0%    ~     (p=1.000 n=5+5)

@spiffcs spiffcs merged commit e650253 into main Sep 28, 2022
@spiffcs spiffcs deleted the developer-docs branch September 28, 2022 17:05
spiffcs added a commit that referenced this pull request Oct 13, 2022
* main: (45 commits)
  feat: add RelationshipsBySourceOwnership to syft json output (#1248)
  fix: reset merged package into map; (#1258)
  refactor: Remove experimental Anchore Enterprise upload functionality (#1257)
  Update syft bootstrap tools to latest versions. (#1254)
  Update Stereoscope to d24c9d626b33fa720210b007a20767801827b532 (#1253)
  Update syft bootstrap tools to latest versions. (#1244)
  fix apkdb checksum representation (#1247)
  feat: add identifiable field to source object (#1243)
  feat: attest support for Singularity images (#1201)
  Update syft bootstrap tools to latest versions. (#1239)
  Update Stereoscope to 1b1b744a919964f38d14e1416fb3f25221b761ce (#1240)
  fix: Follow symlinks when searching for globs in all-layers scope (#1221)
  update requires to use list; remove field (#1234)
  Add Conan (C/C++) conan.lock file support (#1230)
  add sequence diagrams and flesh out TODO notes (#1233)
  Do not fail if unable to parse `.rpm` file (#1232)
  fix: support exclude patterns on Windows (#1228)
  Update syft bootstrap tools to latest versions. (#1225)
  Update Stereoscope to 56552770e555d764ea72b99d3c810326b27ead4a (#1224)
  Update syft bootstrap tools to latest versions. (#1223)
  ...

Signed-off-by: Christopher Phillips <[email protected]>
aiwantaozi pushed a commit to aiwantaozi/syft that referenced this pull request Oct 20, 2022
spiffcs added a commit that referenced this pull request Oct 21, 2022
spiffcs added a commit that referenced this pull request Oct 21, 2022
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
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