Skip to content

Commit

Permalink
Merge pull request #1660 from murlakatamenka/grammar-fixes
Browse files Browse the repository at this point in the history
Grammar fixes; mmap alloc failed error remark for Arch Linux.
  • Loading branch information
psychocrypt authored Jul 14, 2018
2 parents 2d9e0ab + 87b8e4c commit 801ab27
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Reference: http://rybkaforum.net/cgi-bin/rybkaforum/topic_show.pl?pid=259791#pid

If you set up the user rights properly ([see above](https://github.com/fireice-uk/xmr-stak/blob/master/doc/FAQ.md#selockmemoryprivilege-failed)), and your system has 4-8GB of RAM (50%+ use), there is a significant chance that there simply won't be a large enough chunk of contiguous memory because Windows is fairly bad at mitigating memory fragmentation.

If that happens, disable all auto-staring applications and run the miner after a reboot.
If that happens, disable all auto-starting applications and run the miner after a reboot.

## Error msvcp140.dll and vcruntime140.dll not available

Expand All @@ -46,11 +46,11 @@ Download and install this [runtime package](https://go.microsoft.com/fwlink/?Lin

On Linux you will need to configure large page support and increase your ulimit -l.

To set large page support, add the following lines to /etc/sysctl.conf:
To set large page support, add the following lines to `/etc/sysctl.conf` (`/etc/sysctl.d/xmr-stak.conf` for [Arch Linux](https://www.archlinux.org/news/deprecation-of-etcsysctlconf/) and its derivatives):

vm.nr_hugepages=128

To increase the ulimit, add following lines to /etc/security/limits.conf:
To increase the ulimit, add following lines to `/etc/security/limits.conf`:

* soft memlock 262144
* hard memlock 262144
Expand Down
16 changes: 8 additions & 8 deletions doc/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ There are two easy ways to set variables for `cmake` to configure *xmr-stak*
- edit your options
- end the GUI by pressing the key `c`(create) and than `g`(generate)
- set Options on the command line
- enable a option: `cmake .. -DNAME_OF_THE_OPTION=ON`
- disable a option `cmake .. -DNAME_OF_THE_OPTION=OFF`
- enable an option: `cmake .. -DNAME_OF_THE_OPTION=ON`
- disable an option `cmake .. -DNAME_OF_THE_OPTION=OFF`
- set a value `cmake .. -DNAME_OF_THE_OPTION=value`

After the configuration you need to compile the miner, follow the guide for your platform:
Expand All @@ -43,28 +43,28 @@ After the configuration you need to compile the miner, follow the guide for your
- `CMAKE_BUILD_TYPE` set the build type
- valid options: `Release` or `Debug`
- you should always keep `Release` for your productive miners
- `MICROHTTPD_ENABLE` allow to disable/enable the dependency *microhttpd*
- `MICROHTTPD_ENABLE` allows to disable/enable the dependency *microhttpd*
- there is no *http* interface available if option is disabled: `cmake .. -DMICROHTTPD_ENABLE=OFF`
- `OpenSSL_ENABLE` allow to disable/enable the dependency *OpenSSL*
- `OpenSSL_ENABLE` allows to disable/enable the dependency *OpenSSL*
- it is not possible to connect to a *https* secured pool if option is disabled: `cmake .. -DOpenSSL_ENABLE=OFF`
- `XMR-STAK_COMPILE` select the CPU compute architecture (default: native)
- native means the miner binary can be used only on the system where it is compiled but will archive the highest hash rate
- use `cmake .. -DXMR-STAK_COMPILE=generic` to run the miner on all CPU's with sse2

## CPU Build Options

- `CPU_ENABLE` allow to disable/enable the CPU backend of the miner
- `HWLOC_ENABLE` allow to disable/enable the dependency *hwloc*
- `CPU_ENABLE` allows to disable/enable the CPU backend of the miner
- `HWLOC_ENABLE` allows to disable/enable the dependency *hwloc*
- the config suggestion is not optimal if option is disabled: `cmake .. -DHWLOC_ENABLE=OFF`
- disabling can be reduce the miner performance

## AMD Build Options

- `OpenCL_ENABLE` allow to disable/enable the AMD backend of the miner
- `OpenCL_ENABLE` allows to disable/enable the AMD backend of the miner

## NVIDIA Build Options

- `CUDA_ENABLE` allow to disable/enable the NVIDIA backend of the miner
- `CUDA_ENABLE` allows to disable/enable the NVIDIA backend of the miner
- `CUDA_ARCH` build for a certain compute architecture
- this option needs a semicolon separated list
- `cmake .. -DCUDA_ARCH=61` or `cmake .. -DCUDA_ARCH=20;61`
Expand Down
2 changes: 1 addition & 1 deletion scripts/build_xmr-stak_docker/build_xmr-stak_docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ chmod a+x cuda_*_linux-run
########################
# Fedora 27
########################
# CUDA is not going to work on Fedora 27 beacuse it's only support these distributions: http://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html
# CUDA is not going to work on Fedora 27 beacuse it only supports these distributions: http://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html
docker run --rm -it -v $PWD:/mnt fedora:27 /bin/bash -c "
set -x ;
dnf install -y -q cmake gcc-c++ hwloc-devel libmicrohttpd-devel libstdc++-static make openssl-devel;
Expand Down

0 comments on commit 801ab27

Please sign in to comment.