Skip to content

Commit

Permalink
Namecoin: Rebrand namecoin.conf references
Browse files Browse the repository at this point in the history
namecoin.conf's filename was rebranded already, but references to it
still used bitcoin.conf. This caused a Guix build fail for Linux
targets, and probably also Windows targets.
  • Loading branch information
Jeremy Rand committed Aug 13, 2024
1 parent b3b7c95 commit c50f25e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion contrib/guix/libexec/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ mkdir -p "$DISTSRC"

# copy over the example bitcoin.conf file. if contrib/devtools/gen-bitcoin-conf.sh
# has not been run before buildling, this file will be a stub
cp "${DISTSRC}/share/examples/bitcoin.conf" "${DISTNAME}/"
cp "${DISTSRC}/share/examples/namecoin.conf" "${DISTNAME}/"

cp -r "${DISTSRC}/share/rpcauth" "${DISTNAME}/share/"

Expand Down
20 changes: 10 additions & 10 deletions doc/bitcoin-conf.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# `bitcoin.conf` Configuration File
# `namecoin.conf` Configuration File

The configuration file is used by `bitcoind`, `bitcoin-qt` and `bitcoin-cli`.
The configuration file is used by `namecoind`, `namecoin-qt` and `namecoin-cli`.

All command-line options (except for `-?`, `-help`, `-version` and `-conf`) may be specified in a configuration file, and all configuration file options (except for `includeconf`) may also be specified on the command line. Command-line options override values set in the configuration file and configuration file options override values set in the GUI.

Changes to the configuration file while `bitcoind` or `bitcoin-qt` is running only take effect after restarting.
Changes to the configuration file while `namecoind` or `namecoin-qt` is running only take effect after restarting.

Users should never make any configuration changes which they do not understand. Furthermore, users should always be wary of accepting any configuration changes provided to them by another source (even if they believe that they do understand them).

Expand Down Expand Up @@ -51,24 +51,24 @@ rpcport=4000

## Configuration File Path

The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `namecoin.conf` and it is located in the Namecoin data directory, but both the Namecoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.

The `includeconf=<file>` option in the `bitcoin.conf` file can be used to include additional configuration files.
The `includeconf=<file>` option in the `namecoin.conf` file can be used to include additional configuration files.

### Default configuration file locations

Operating System | Data Directory | Example Path
-- | -- | --
Windows | `%LOCALAPPDATA%\Bitcoin\` | `C:\Users\username\AppData\Local\Bitcoin\bitcoin.conf`
Linux | `$HOME/.bitcoin/` | `/home/username/.bitcoin/bitcoin.conf`
macOS | `$HOME/Library/Application Support/Bitcoin/` | `/Users/username/Library/Application Support/Bitcoin/bitcoin.conf`
Windows | `%LOCALAPPDATA%\Namecoin\` | `C:\Users\username\AppData\Local\Namecoin\namecoin.conf`
Linux | `$HOME/.namecoin/` | `/home/username/.namecoin/namecoin.conf`
macOS | `$HOME/Library/Application Support/Namecoin/` | `/Users/username/Library/Application Support/Namecoin/namecoin.conf`

An example configuration file can be generated by [contrib/devtools/gen-bitcoin-conf.sh](../contrib/devtools/gen-bitcoin-conf.sh).
Run this script after compiling to generate an up-to-date configuration file.
The output is placed under `share/examples/bitcoin.conf`.
The output is placed under `share/examples/namecoin.conf`.
To use the generated configuration file, copy the example file into your data directory and edit it there, like so:

```
# example copy command for linux user
cp share/examples/bitcoin.conf ~/.bitcoin
cp share/examples/namecoin.conf ~/.namecoin
```
4 changes: 2 additions & 2 deletions share/setup.nsi.in
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Section -Main SEC0000
File @abs_top_builddir@/release/@BITCOIN_GUI_NAME@@EXEEXT@
File /oname=COPYING.txt @abs_top_srcdir@/COPYING
File /oname=readme.txt @abs_top_srcdir@/doc/README_windows.txt
File @abs_top_srcdir@/share/examples/bitcoin.conf
File @abs_top_srcdir@/share/examples/namecoin.conf
SetOutPath $INSTDIR\share\rpcauth
File @abs_top_srcdir@/share/rpcauth/*.*
SetOutPath $INSTDIR\daemon
Expand Down Expand Up @@ -130,7 +130,7 @@ Section /o -un.Main UNSEC0000
Delete /REBOOTOK $INSTDIR\@BITCOIN_GUI_NAME@@EXEEXT@
Delete /REBOOTOK $INSTDIR\COPYING.txt
Delete /REBOOTOK $INSTDIR\readme.txt
Delete /REBOOTOK $INSTDIR\bitcoin.conf
Delete /REBOOTOK $INSTDIR\namecoin.conf
RMDir /r /REBOOTOK $INSTDIR\share
RMDir /r /REBOOTOK $INSTDIR\daemon
DeleteRegValue HKCU "${REGKEY}\Components" Main
Expand Down

0 comments on commit c50f25e

Please sign in to comment.