forked from scala/scala3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(docs): update the contributing docs (scala#17585)
This makes a bunch of small updates the contributing docs that were recently migrated over from the scala-lang site. I think there are actually some more updates to be done, but much of these changes are just structural. To sort of summarize this does the following: - gets rid of old irrelevant things like the `checklist.sh` - removes some instructions that are no longer relevant - re-organizes the side bar to better group things by topic - gets rid of redundant information and tries to group things better - moves the scaladoc docs into the contributing docs I'll add some more comments inline to further explain. [skip community_build] _Old sidebar_ <img width="321" alt="Screenshot 2023-05-25 at 15 18 32" src="https://github.com/lampepfl/dotty/assets/13974112/2e493110-8098-445c-b101-166998c7c95f"> _New sidebar_ <img width="321" alt="Screenshot 2023-05-25 at 15 18 03" src="https://github.com/lampepfl/dotty/assets/13974112/2f86764e-bc3e-4356-9f56-006197a10153">
- Loading branch information
Showing
28 changed files
with
490 additions
and
786 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
layout: doc-page | ||
title: Command Cheatsheet | ||
--- | ||
|
||
## sbt commands | ||
|
||
Below is a cheat sheet of some frequently used commands to be used from SBT | ||
console – `sbt`. | ||
|
||
|
||
| Command | Description | | ||
|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| | ||
| `scala3/scalac` | Run the compiler directly, with any current changes. | | ||
| `scala3/scala` | Run the main method of a given class name. | | ||
| `scalac ../issues/Playground.scala` | Compile the given file – path relative to the Dotty directory. Output the compiled class files to the Dotty directory itself. | | ||
| `scala Playground` | Run the compiled class `Playground`. Dotty directory is on classpath by default. | | ||
| `repl` | Start REPL | | ||
| `scala3/scalac -print-tasty Foo.tasty` | Print the TASTy of top-level class `Foo` | | ||
| `scala3-bootstrapped/test` | Run all tests for Scala 3. (Slow, recommended for CI only) | | ||
| `scala3-bootstrapped/publishLocal` | Build Scala 3 locally. (Use to debug a specific project) | | ||
| `testOnly dotty.tools.dotc.CompilationTests -- *pos` | Run test (method) `pos` from `CompilationTests` suite. | | ||
| `testCompilation sample` | In all test suites, run test files containing the word `sample` in their title. | | ||
| `scala3-compiler/Test/runMain dotty.tools.printTypes`| Print types underlying representation | | ||
| `scaladoc/generateScalaDocumentation` | Build the documentation website (published to https://dotty.epfl.ch) | | ||
| `scaladoc/generateReferenceDocumentation` | Build the reference documentation website (published to https://docs.scala-lang.org/scala3/reference) | | ||
|
||
|
||
## Shell Commands | ||
|
||
Below is a cheat sheet of some frequently used commands to be used from your | ||
shell. | ||
|
||
| Command | Description | | ||
|--------------------------------------|------------------------------------------------------------------| | ||
| `rm -rv *.tasty *.class out || true` | clean all compiled artifacts, from root dotty directory | | ||
| `git clean -fdx` | a full clean of all files in the codebase not tracked by git | |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
layout: doc-page | ||
title: Debugging the Compiler | ||
redirectFrom: /docs/contributing/issues/debugging.html | ||
--- | ||
|
||
This section goes over the various ways to debug either the compiler or the code | ||
that you're having issues with. This can be just inspecting the trees of your | ||
code or stepping through the dotty codebase with a Debugger. | ||
|
||
The following sections will help you with this: | ||
- [Debugging with your IDE](./ide-debugging.md.md) | ||
- [How to Inspect Values](./inspection.md) | ||
- [Other Debugging Techniques](./other-debugging.md) |
2 changes: 1 addition & 1 deletion
2
docs/_docs/contributing/issues/debugging.md → ...s/contributing/debugging/ide-debugging.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.