Skip to content

Commit

Permalink
gh-pages: remove mention of deprecated flags (#22265)
Browse files Browse the repository at this point in the history
* update docs to remove old deprecated flags

* typo
  • Loading branch information
renaynay committed Feb 16, 2021
1 parent 4a82e81 commit b7f5e58
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/_clef/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sort_key: C

### External API

Clef listens to HTTP requests on `rpcaddr`:`rpcport` (or to IPC on `ipcpath`), with the same JSON-RPC standard as Geth. The messages are expected to be [JSON-RPC 2.0 standard](https://www.jsonrpc.org/specification).
Clef listens to HTTP requests on `http.addr`:`http.port` (or to IPC on `ipcpath`), with the same JSON-RPC standard as Geth. The messages are expected to be [JSON-RPC 2.0 standard](https://www.jsonrpc.org/specification).

Some of these calls can require user interaction. Clients must be aware that responses may be delayed significantly or may never be received if a user decides to ignore the confirmation request.

Expand Down
4 changes: 2 additions & 2 deletions docs/_dapp/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ debug.traceTransaction("0xfc9359e49278b7ba99f59edac0e3de49956e46e530a53c15aa7122
```

The same call can of course be invoked from outside the node too via HTTP RPC. In this
case, please make sure the HTTP endpoint is enabled via `--rpc` and the `debug` API
namespace exposed via `--rpcapi=debug`.
case, please make sure the HTTP endpoint is enabled via `--http` and the `debug` API
namespace exposed via `--http.api=debug`.

```
$ curl -H "Content-Type: application/json" -d '{"id": 1, "method": "debug_traceTransaction", "params": ["0xfc9359e49278b7ba99f59edac0e3de49956e46e530a53c15aa71226b7aa92c6f"]}' localhost:8545
Expand Down
6 changes: 3 additions & 3 deletions docs/_developers/devguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ you need to start them up choosing an alternative pprof port. Make sure you are
redirecting stderr to a logfile.

```
geth -port=30300 -verbosity 5 --pprof --pprofport 6060 2>> /tmp/00.glog
geth -port=30301 -verbosity 5 --pprof --pprofport 6061 2>> /tmp/01.glog
geth -port=30302 -verbosity 5 --pprof --pprofport 6062 2>> /tmp/02.glog
geth -port=30300 -verbosity 5 --pprof --pprof.port 6060 2>> /tmp/00.glog
geth -port=30301 -verbosity 5 --pprof --pprof.port 6061 2>> /tmp/01.glog
geth -port=30302 -verbosity 5 --pprof --pprof.port 6062 2>> /tmp/02.glog
```

Alternatively if you want to kill the clients (in case they hang or stalled syncing, etc)
Expand Down
2 changes: 1 addition & 1 deletion docs/_getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The command below also enables the [Geth RPC interface](clef/tutorial)
(which we cover below), and sets Clef as the transaction signer.

```shell
geth --goerli --syncmode "light" --rpc --signer=<CLEF_LOCATION>/clef.ipc
geth --goerli --syncmode "light" --http --signer=<CLEF_LOCATION>/clef.ipc
```

## Get ETH
Expand Down
6 changes: 3 additions & 3 deletions docs/_getting-started/private-net.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ We assume you are able to build `geth` following the [build instructions][build]
In order to run multiple ethereum nodes locally, you have to make sure:

- each instance has a separate data directory (`--datadir`)
- each instance runs on a different port (both eth and rpc) (`--port and --rpcport`)
- each instance runs on a different port (both eth and rpc) (`--port and --http.port`)
- in case of a cluster the instances must know about each other
- the ipc endpoint is unique or the ipc interface is disabled (`--ipcpath or --ipcdisable`)

You start the first node (let's make port explicit and disable ipc interface)

geth --datadir="/tmp/eth/60/01" -verbosity 6 --ipcdisable --port 30301 --rpcport 8101 console 2>> /tmp/eth/60/01.log
geth --datadir="/tmp/eth/60/01" -verbosity 6 --ipcdisable --port 30301 --http.port 8101 console 2>> /tmp/eth/60/01.log

We started the node with the console, so that we can grab the enode url for instance:

Expand All @@ -41,7 +41,7 @@ a service) to construct the enode url.

Now you can launch a second node with:

geth --datadir="/tmp/eth/60/02" --verbosity 6 --ipcdisable --port 30302 --rpcport 8102 console 2>> /tmp/eth/60/02.log
geth --datadir="/tmp/eth/60/02" --verbosity 6 --ipcdisable --port 30302 --http.port 8102 console 2>> /tmp/eth/60/02.log

If you want to connect this instance to the previously started node you can add it as a
peer from the console with `admin.addPeer(enodeUrlOfFirstInstance)`.
Expand Down
23 changes: 0 additions & 23 deletions docs/_interface/Command-Line-Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,6 @@ API AND CONSOLE OPTIONS:
NETWORKING OPTIONS:
--bootnodes value Comma separated enode URLs for P2P discovery bootstrap
--bootnodesv4 value Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes) (deprecated, use --bootnodes)
--bootnodesv5 value Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes) (deprecated, use --bootnodes)
--discovery.dns value Sets DNS discovery entry points (use "" to disable DNS)
--port value Network listening port (default: 30303)
--maxpeers value Maximum number of network peers (network disabled if set to 0) (default: 50)
Expand Down Expand Up @@ -207,27 +205,6 @@ WHISPER (EXPERIMENTAL) OPTIONS:
--shh.pow value Minimum POW accepted (default: 0.2)
--shh.restrict-light Restrict connection between two whisper light clients
ALIASED (deprecated) OPTIONS:
--rpc Enable the HTTP-RPC server (deprecated, use --http)
--rpcaddr value HTTP-RPC server listening interface (deprecated, use --http.addr) (default: "localhost")
--rpcport value HTTP-RPC server listening port (deprecated, use --http.port) (default: 8545)
--rpccorsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) (deprecated, use --http.corsdomain)
--rpcvhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (deprecated, use --http.vhosts) (default: "localhost")
--rpcapi value API's offered over the HTTP-RPC interface (deprecated, use --http.api)
--wsaddr value WS-RPC server listening interface (deprecated, use --ws.addr) (default: "localhost")
--wsport value WS-RPC server listening port (deprecated, use --ws.port) (default: 8546)
--wsorigins value Origins from which to accept websockets requests (deprecated, use --ws.origins)
--wsapi value API's offered over the WS-RPC interface (deprecated, use --ws.api)
--gpoblocks value Number of recent blocks to check for gas prices (deprecated, use --gpo.blocks) (default: 20)
--gpopercentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (deprecated, use --gpo.percentile) (default: 60)
--graphql.addr value GraphQL server listening interface (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql)
--graphql.port value GraphQL server listening port (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql) (default: 8545)
--pprofport value pprof HTTP server listening port (deprecated, use --pprof.port) (default: 6060)
--pprofaddr value pprof HTTP server listening interface (deprecated, use --pprof.addr) (default: "127.0.0.1")
--memprofilerate value Turn on memory profiling with the given rate (deprecated, use --pprof.memprofilerate) (default: 524288)
--blockprofilerate value Turn on block profiling with the given rate (deprecated, use --pprof.blockprofilerate) (default: 0)
--cpuprofile value Write CPU profile to the given file (deprecated, use --pprof.cpuprofile)
MISC OPTIONS:
--snapshot Enables snapshot-database mode -- experimental work in progress feature
--help, -h show help
Expand Down
2 changes: 1 addition & 1 deletion docs/_interface/JavaScript-Console.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ipc endpoint or you would like to connect over the rpc interface.

Note that by default the geth node doesn't start the HTTP and WebSocket servers and not
all functionality is provided over these interfaces for security reasons. These defaults
can be overridden with the `--rpcapi` and `--wsapi` arguments when the geth node is
can be overridden with the `--http.api` and `--ws.api` arguments when the geth node is
started, or with [admin.startRPC](../rpc/ns-admin#admin_startrpc) and
[admin.startWS](../rpc/ns-admin#admin_startws).

Expand Down
6 changes: 3 additions & 3 deletions docs/_interface/Private-Network.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ block, you need to decide on a few initial parameters for your blockchain:
- Initial block gas limit (`gasLimit`). Your choice here impacts how much EVM computation
can happen within a single block. We recommend using the main Ethereum network as a
[guideline to find a good amount][gaslimit-chart]. The block gas limit can be adjusted
after launch using the `--targetgaslimit` command-line flag.
after launch using the `--miner.gastarget` command-line flag.
- Initial allocation of ether (`alloc`). This determines how much ether is available to
the addresses you list in the genesis block. Additional ether can be created through
mining as the chain progresses.
Expand Down Expand Up @@ -282,7 +282,7 @@ geth <other-flags> --unlock 0x7df9a875a174b3bc565e6424a0050ebc1b2d1d82 --mine
```

You can further configure mining by changing the default gas limit blocks converge to
(with `--targetgaslimit`) and the price transactions are accepted at (with `--gasprice`).
(with `--miner.gastarget`) and the price transactions are accepted at (with `--miner.gasprice`).

### Ethash: Running A Miner

Expand All @@ -291,7 +291,7 @@ create a stable stream of blocks at regular intervals. To start a Geth instance
mining, run it with all the usual flags and add the following to configure mining:

```shell
geth <other-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000
geth <other-flags> --mine --miner.threads=1 --etherbase=0x0000000000000000000000000000000000000000
```

This will start mining bocks and transactions on a single CPU thread, crediting all block
Expand Down
12 changes: 6 additions & 6 deletions docs/_interface/mining.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ as the example address.

Now start geth and wait for it to sync the blockchain. This will take quite a while.

geth --rpc --etherbase 0xC95767AC46EA2A9162F0734651d6cF17e5BfcF10
geth --http --miner.etherbase 0xC95767AC46EA2A9162F0734651d6cF17e5BfcF10

Now we're ready to start mining. In a new terminal session, run ethminer and connect it to geth:

ethminer -G -P http://127.0.0.1:8545

`ethminer` communicates with geth on port 8545 (the default RPC port in geth). You can
change this by giving the [`--rpcport` option](../rpc/server) to `geth`. Ethminer will find
get on any port. You also need to set the port on `ethminer` with `-P
change this by giving the [`--http.port` option](../rpc/server) to `geth`. Ethminer will find
geth on any port. You also need to set the port on `ethminer` with `-P
http://127.0.0.1:3301`. Setting up custom ports is necessary if you want several instances
mining on the same computer. If you are testing on a private cluster, we recommend you use
CPU mining instead.
Expand All @@ -72,11 +72,11 @@ with `ethminer`, `miner.hashrate` will always report 0.
## CPU Mining with Geth

When you start up your ethereum node with `geth` it is not mining by default. To start it
in mining mode, you use the `--mine` command-line flag. The `--minerthreads` parameter can
in mining mode, you use the `--mine` command-line flag. The `--miner.threads` parameter can
be used to set the number parallel mining threads (defaulting to the total number of
processor cores).

geth --mine --minerthreads=4
geth --mine --miner.threads=4

You can also start and stop CPU mining at runtime using the
[console](../interface/javascript-console). `miner.start` takes an optional parameter for
Expand All @@ -98,7 +98,7 @@ you don't have an etherbase address, then `geth --mine` will not start up.

You can set your etherbase on the command line:

geth --etherbase '0xC95767AC46EA2A9162F0734651d6cF17e5BfcF10' --mine 2>> geth.log
geth --miner.etherbase '0xC95767AC46EA2A9162F0734651d6cF17e5BfcF10' --mine 2>> geth.log

You can reset your etherbase on the console too:

Expand Down
2 changes: 1 addition & 1 deletion docs/_rpc/ns-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ Writes a goroutine blocking profile to the given file.
Writes an allocation profile to the given file.
Note that the profiling rate cannot be set through the API,
it must be set on the command line using the `--memprofilerate`
it must be set on the command line using the `--pprof.memprofilerate`
flag.
| Client | Method invocation |
Expand Down
4 changes: 2 additions & 2 deletions docs/_rpc/ns-eth.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ call.

#### Simple example

With a synced Rinkeby node with RPC exposed on localhost (`geth --rinkeby --rpc`) we can
With a synced Rinkeby node with RPC exposed on localhost (`geth --rinkeby --http`) we can
make a call against the [Checkpoint
Oracle](https://rinkeby.etherscan.io/address/0xebe8efa441b9302a0d7eaecc277c09d20d684540)
to retrieve the list of administrators:
Expand Down Expand Up @@ -163,7 +163,7 @@ contract CheckpointOracle {
}
```

With a synced Rinkeby node with RPC exposed on localhost (`geth --rinkeby --rpc`) we can
With a synced Rinkeby node with RPC exposed on localhost (`geth --rinkeby --http`) we can
make a call against the live [Checkpoint
Oracle](https://rinkeby.etherscan.io/address/0xebe8efa441b9302a0d7eaecc277c09d20d684540),
but override its byte code with our own version that has an accessor for the voting
Expand Down

0 comments on commit b7f5e58

Please sign in to comment.