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

Fix broken mdoc #1600

Merged
merged 5 commits into from
Sep 24, 2020
Merged

Fix broken mdoc #1600

merged 5 commits into from
Sep 24, 2020

Conversation

azidar
Copy link
Contributor

@azidar azidar commented Sep 23, 2020

Contributor Checklist

  • [NA] Did you add Scaladoc to every public function/method?
  • [NA] Did you add at least one test demonstrating the PR?
  • [NA] Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • [NA] 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

  • bug fix

API Impact

No change.

Backend Code Generation Impact

None.

Desired Merge Strategy

  • Squash: The PR will be squashed and merged

Release Notes

Fixed bug in docs/mdoc, where they aren't building properly.

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 23, 2020 23:50
@azidar azidar requested review from albert-magyar and removed request for a team September 23, 2020 23:50
@azidar azidar requested a review from jackkoenig September 24, 2020 16:33
@azidar azidar mentioned this pull request Sep 24, 2020
Merged
11 tasks
seldridge
seldridge approved these changes Sep 24, 2020
View reviewed changes
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

Nice improvement. Adding the CI ensures mdoc correctness going forward.

@azidar azidar merged commit 0e87d8e into master Sep 24, 2020
@azidar azidar added this to the 3.4.0 milestone Sep 24, 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 <[email protected]>

Co-authored-by: Adam Izraelevitz <[email protected]>
Co-authored-by: Chick Markley <[email protected]>
@jackkoenig jackkoenig deleted the fix-mdoc branch October 19, 2020 19:40
@MAFOR-TECH MAFOR-TECH mentioned this pull request Oct 24, 2021
Closed
jackkoenig pushed a commit that referenced this pull request Feb 28, 2023
@albert-magyar
consolidated wire+assign to just wire, with expression inlined (#1600)
96fbaf5 
* consolidated wire <type> x; assign x = y; to wire <type> x = y;

* Remove dead code from Emitter.scala

Co-authored-by: Albert Magyar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seldridge seldridge seldridge approved these changes

@albert-magyar albert-magyar Awaiting requested review from albert-magyar

@jackkoenig jackkoenig Awaiting requested review from jackkoenig

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
3.4.0
Development

Successfully merging this pull request may close these issues.
2 participants
@azidar @seldridge