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.

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

Move more docs #1601

Merged
merged 10 commits into from
Oct 5, 2020
Merged

Move more docs #1601

merged 10 commits into from
Oct 5, 2020

Conversation

azidar
Copy link
Contributor

@azidar azidar commented Sep 24, 2020

Depends on #1600

Contributor Checklist

  • [N/A] Did you add Scaladoc to every public function/method?
  • [N/A] Did you add at least one test demonstrating the PR?
  • [N/A] Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • documentation

API Impact

Backend Code Generation Impact

N/A

Desired Merge Strategy

  • Squash: The PR will be squashed and merged

Release Notes

Updated more docs to the new mdoc framework.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (3.2.x, 3.3.x, 3.4.0, 3.5.0) ?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you mark as Please Merge?

@azidar azidar requested a review from a team as a code owner September 24, 2020 16:53
@azidar azidar requested review from albertchen-sifive and removed request for a team September 24, 2020 16:53
albertchen-sifive
albertchen-sifive approved these changes Sep 24, 2020
View reviewed changes
Copy link
Contributor

@albertchen-sifive albertchen-sifive left a comment

Choose a reason for hiding this comment

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

LGTM

@seldridge seldridge added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Oct 5, 2020
seldridge added a commit that referenced this pull request Oct 5, 2020
@seldridge
Backport #1601 to 3.4.x
6b2bce9 
This is a manual backport of PR #1601 to the 3.4.x branch. This adds
improved documentation to annotations, blackbox, and bundles/vecs.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
@seldridge seldridge mentioned this pull request Oct 5, 2020
Merged
@mergify mergify bot merged commit 03e6c2b into master Oct 5, 2020
chick added a commit that referenced this pull request Oct 5, 2020
@seldridge @azidar @chick
Merge master into 3.4.x (better mdoc, Apache license) (#1605)
d033d41 
* Fix broken mdoc (#1600)

* Fix broken mdoc

* Added test-chisel-docs to ci workflow

* Move Chisel3 to SPDX license conventions (#1604)

Change source and other relevant files to use SPDX license
LICENSE file moved from src/ to ./
Changed license file to refer to this per recommendation
using_spdx_license_list_short_identifiers

WARNING: Tests fail with as of yet undiagnosed error
```
[error] Failed: Total 691, Failed 19, Errors 0, Passed 672, Ignored 15
[error] Failed tests:
[error] 	chiselTests.QueueSpec
[error] 	examples.VendingMachineGeneratorSpec
[error] 	chiselTests.HarnessSpec
[error] 	chiselTests.ConnectSpec
[error] 	chiselTests.aop.SelectSpec
[error] 	chiselTests.PopCountSpec
[error] 	chiselTests.CloneModuleSpec
[error] (Test / test) sbt.TestsFailedException: Tests unsuccessful
[error] Total time: 379 s (06:19), completed Sep 30, 2020 12:38:17 AM
sbt:chisel3>
```

* Move more docs (#1601)

* Fix broken mdoc

* Added test-chisel-docs to ci workflow

* Add requirement on build-treadle job

* Added forgotton colon

* Forgot cd into chisel3 dir

* moved three docs into explanations

* Updated reference

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@gmail.com>

Co-authored-by: Adam Izraelevitz <azidar@gmail.com>
Co-authored-by: Chick Markley <chick@qrhino.com>
@jackkoenig jackkoenig deleted the move-more-docs branch October 19, 2020 19:40
@MAFOR-TECH MAFOR-TECH mentioned this pull request Oct 24, 2021
Closed
jackkoenig added a commit that referenced this pull request Feb 28, 2023
@jackkoenig
Merge pull request #1601 from freechipsproject/speed-up-infer-types
f4e4ee0 
Speed up InferTypes and CInferTypes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@albertchen-sifive albertchen-sifive albertchen-sifive approved these changes

Assignees
No one assigned
Labels
Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@azidar @albertchen-sifive @seldridge