Update doc: conf.toml detail

李衍志523370910113 2024-09-15 23:18:56 +08:00
parent 2313ce734a
commit ccfbbbea5d

@ -1,14 +1,14 @@
`conf.toml` file contains the details of steps that should be executed to the newly pushed code. This file will be placed in the repo of each student. `conf.toml` file contains the details of steps that should be executed to the newly pushed code. This file will be placed in the repo of each student.
The `conf.toml` file will begin with: The `conf.toml` file will begin with:
``` ```toml
logLevel = -4 logLevel = -4
sandboxExecServer = "172.17.0.1:5051" sandboxExecServer = "172.17.0.1:5051"
``` ```
which helps logging into the server. which helps logging into the server.
In the file, there will be many stages stating each parser to run. To be more specific, the parsers below: In the file, there will be many stages stating each parser to run. To be more specific, the parsers below:
``` ```markdown
- clangtidy - clangtidy
- cppcheck - cppcheck
- cpplint - cpplint
@ -22,7 +22,7 @@ In the file, there will be many stages stating each parser to run. To be more sp
During the `run-joj` process, we will have **several stages** where we will apply different parsers to the code. Those **stages and parsers** are what the users should know how to set. The sandbox executor always sends to go-judge. Stages run one by one. Each stage contains an executor that runs command and give the command output, and a parser that parse the output and generate score and comment. During the `run-joj` process, we will have **several stages** where we will apply different parsers to the code. Those **stages and parsers** are what the users should know how to set. The sandbox executor always sends to go-judge. Stages run one by one. Each stage contains an executor that runs command and give the command output, and a parser that parse the output and generate score and comment.
Here are the template code for stages and parsers: Here are the template code for stages and parsers:
``` ```toml
[[stages]] [[stages]]
name = "" # stage name here name = "" # stage name here
[stages.executor] [stages.executor]