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

Revised Documentation for Accuracy & Transitioned to USDOT fork of asn1c repository #48

Merged
merged 33 commits into from
Jun 11, 2024

Conversation

dmccoystephenson
Copy link
Collaborator

@dmccoystephenson dmccoystephenson commented May 20, 2024

Revised Documentation for Accuracy

The documentation for the project has been reviewed and revised for accuracy. In some cases, improvements were made to formatting/organization to improve clarity.

Changes

README.md

  • Fixed a typo ("Metatdata" instead of "Metadata")
  • Adjusted headers to improve clarity
  • Removed outdated 'Project Management' section in README
  • Moved 'Confluent Cloud Integration' section to bottom of README

installation.md

  • Adjusted headers & added table of contents to installation.md
  • Moved 'Docker Installation' section to top of installation.md
  • Heavily revised the docker/manual installation documentation in installation.md to ensure accuracy

interface.md

  • Adjusted headers
  • Fixed a typo (heirarchy instead of hierarchy)

configuration.md

  • Fixed a typo
  • Adjusted headers
  • Revised ACM Testing with Kafka section

testing.md

  • Reorganized document
  • Added docker info

Transitioned to USDOT fork of asn1c repository

Problem

USDOT has recently created a fork of the mouse07410/asn1c project. To maintain internal references, the project needs to switch to using this new fork.

Solution

The project now uses https://github.com/usdot-fhwa-stol/usdot-asn1c as its ASN.1 Compiler. References to the submodule have been updated in the relevant scripts and Dockerfiles.

Testing

  • Installing the asn1c tool has been verified to work
  • Generating the J2735 implementation/header files has been verified to work for 2016 & 2020
  • The docker image can be built successfully using the new 2020 generated files
  • Unit tests are verified to be passing.

Note

It should be noted that using the latest commit in usdot-fhwa-stol/usdot-asn1c results in failure to compile the ACM. To work around this, the following commit is being referenced:
usdot-fhwa-stol/usdot-asn1c@e74487c

@dmccoystephenson dmccoystephenson changed the title Revised Documentation for Accuracy Revised Documentation for Accuracy & Transitioned to USDOT fork of asn1c repository Jun 3, 2024
Write output from the ASN1_Codec::filetest function directly to stdout
@dan-du-car dan-du-car merged commit 681cf4a into usdot-jpo-ode:develop Jun 11, 2024
2 checks passed
@dmccoystephenson dmccoystephenson deleted the develop branch June 11, 2024 13:04
@dmccoystephenson dmccoystephenson restored the develop branch June 11, 2024 13:07
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.

4 participants