Commit Graph

37 Commits

Author SHA1 Message Date
Ian Jackson c8973ae248 Merge branch 'docs-runes' into 'main'
CONTRIBUTING.md: Improve wording about docs builds recommendations

See merge request tpo/core/arti!1090
2023-03-31 16:52:31 +00:00
Ian Jackson ab7e628555 CONTRIBUTING.md: Explicitly support --document-private-items
We have many internal doc comments with curated links etc., so we
should actually mention that formatting and reading those can be
useful.
2023-03-30 16:34:57 +01:00
Ian Jackson 922df2a10f CONTRIBUTING.md: Recommend --workspace when building docs 2023-03-30 16:34:53 +01:00
Ian Jackson 3746ad8c84 CONTRIBUTING.md: Add some refs for git autosquash
One ref to the official docs, one to a reasonable-looking blog post I
found via DDG.

Suggested in
  https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1079#note_2889631
2023-03-30 16:32:04 +01:00
Ian Jackson f7f3ad37ff CONTRIBUTING.md: Discourage contributors from rebasing (typo fix) 2023-03-30 16:32:00 +01:00
Nick Mathewson b62c46f0b5 CONTRIBUTING.md: Improve wording re not squashing 2023-03-30 16:31:36 +01:00
Ian Jackson 8882df7c51 CONTRIBUTING.md: Document X X X convention
The placement in the "Where are some good places to start hacking?"
section is rather awkward, but I didn't see where else to put it.
2023-03-30 16:31:36 +01:00
Ian Jackson ee9486f52d CONTRIBUTING.md: Add more notes about TODOs
The placement in the "Where are some good places to start hacking?"
section is rather awkward, but I didn't see where else to put it.
2023-03-30 16:31:36 +01:00
Ian Jackson a55ed63c6c CONTRIBUTING.md: Discourage contributors from rebasing 2023-03-30 16:31:36 +01:00
Emil Engler 4f5170e6f0
doc: mention `maint/check_env` in CONTRIBUTING.md 2023-02-24 18:32:06 +01:00
Emil Engler 63fd69d66e
doc: fix links to Architecture.md
See 2c240923fc.
2022-12-20 14:04:21 +01:00
Ian Jackson b19547e15a docs: Move Tor Browser part to arti top-level (code motion) 2022-09-02 16:58:15 +01:00
trinity-1686a f5c2974a65 add link to coverage reports 2022-05-26 13:14:00 +02:00
eta 6fc7a864c7 Remove cargo-husky, and replace with manual instructions
A build script reaching into your .git/hooks/ and modifying them
nonconsensually was a bit of a horrifying concept, and also made it hard
to build arti with the feature disabled. Remove this crate, and replace
it with manual instructions on how to install the hooks in
CONTRIBUTING.md.
2022-05-10 13:36:49 +01:00
Steven Murdoch d75b46c3e3 Note the dependency on PCRE support in Git implied by the use of grep -P in the git hooks 2022-03-08 13:27:31 +00:00
Ian Jackson 9ee78ea4e0 Merge branch 'contributing-dependencies' into 'main'
Add missing dependencies to CONTRIBUTING.md

See merge request tpo/core/arti!389
2022-03-07 17:39:05 +00:00
Lennart Kloock 15cfce6939
Add more explaining text 2022-03-05 12:23:46 +01:00
Lennart Kloock c92e2b6b6e
Add link to shellcheck installation guide 2022-03-05 12:10:43 +01:00
Lennart Kloock 1af47fbbf4
Add required dependencies to compile `arti` and run git hooks to CONTRIBUTING.md 2022-03-05 12:06:37 +01:00
Steven Murdoch b041bebe9d Add instructions for hooking up Tor Browser to arti on Windows 2022-03-04 22:56:55 +00:00
Nick Mathewson c3f82ee14d README,CONTRIBUTING: More links.
Explain how to report bugs and how get accounts on the bugtracker;
add link to the troubleshooting document.

Part of #277
2022-01-21 10:59:14 -05:00
Ian Jackson 1250fc68ce CONTRIBUTING: Document how to build the docs
Eventually we may need a separate HACKING.md
2022-01-20 17:36:37 +00:00
Nick Mathewson d82d70939e Update CONTRIBUTING to mention FIXME, not XXX. 2021-12-20 13:52:13 -05:00
eta 4fa0122dde Improve and future-proof the `arti` CLI
This switches out `arti`'s argument-parsing library with `clap`, which
is a lot more featureful (and very widely used within the Rust
ecosystem). We also now use a lot of `clap`'s features to improve the
CLI experience:

- The CLI now expects a subcommand (currently, either "help", or "proxy"
  for the existing SOCKS proxy behaviour). This should let us add
  additional non-SOCKS-proxy features to arti in future.
- `clap` supports default values determined at runtime, so the way the
  default config file is loaded was changed: now, we determine the
  OS-specific path for said file before invoking `clap`, so the help
  command can show it properly.
  - The behaviour of `tor_config` was also changed; now, one simply
    specifies a list of configuration files to load, together with
    whether they're required.
  - That function also way overused generics; this has been fixed.
- Instead of using the ARTI_LOG environment variable to configure
  logging, one now uses the `-l, --log-level` CLI option.
  (The intent is for this option to be more discoverable by users.)
- The `proxy` subcommand allows the user to override the SOCKS port used
  on the CLI without editing the config file.
2021-10-27 19:11:48 +01:00
Dimitris Apostolou c26dc07fbb
Fix typos and cleanup 2021-10-25 19:58:42 +03:00
Jani Monoses 4d52f99020 Create a separate logging section in config. 2021-09-09 10:38:29 +03:00
Jani Monoses df73dfe0c8 More flexible tracing configuration.
Replace the trace config file option with a more flexible trace_filter
and expose the same via the ARTI_LOG environment variable.
If ARTI_LOG is set it will override the setting in the config file.

Example:

ARTI_LOG="info,tor_proto::channel=trace" ./target/debug/arti

The syntax is described here
https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/filter/struct.EnvFilter.html#directives
2021-08-26 17:54:06 +03:00
Nick Mathewson 729fccba0c Move MSRV note to README 2021-08-24 15:53:43 -04:00
Nick Mathewson e4795c57d0 Add a quick MSRV note. 2021-08-24 15:50:51 -04:00
Nick Mathewson abb3e2fad5 Light edits on CONTRIBUTING.md
Mainly, drop the suggestion to fetch submodules, and explain what
more things do.

(The only submodule we have now is the fuzzing corpora, which most
people won't want.)

(I am not 100% convinced that we should keep 100% of the
instructions for working with git in the long term.  Do many other
projects have these?  Is there a tutorial we should link to
instead?)
2021-08-09 12:42:10 -04:00
S0AndS0 dea85e7912 WIP: Add development environment setup tips 2021-08-06 15:31:45 -07:00
Nick Mathewson a28e088240 Add OSX instructions to CONTRIBUTING.md
Closes #151.
2021-07-23 15:00:35 -04:00
HackerNCoder 0f9001c811
Fix typos 2021-06-17 17:19:33 +00:00
Nick Mathewson 99a19ea0ba Revise repository-level documentation 2021-06-17 12:18:28 -04:00
Nick Mathewson c2db961424 Move our command-line interface into a new crate called "arti".
Closes #106
2021-03-17 15:14:32 -04:00
Nick Mathewson 106c9097ff Recommend running arti build with --release 2021-02-09 09:31:18 -05:00
George Kadianakis 9ec905e8d0 Add a rough CONTRIBUTING.md file with some dogfooding instructions. 2021-02-08 20:39:52 +02:00