1
0
mirror of https://github.com/xmrig/xmrig.git synced 2026-01-22 14:32:54 -05:00
Commit Graph

19 Commits

Author SHA1 Message Date
rezky_nightky
cb7511507f fix: cross typos detail below:
What I did
Repository rules / exclusions
I didn’t find repo-specific spelling tooling already in place (no existing codespell config).
Given this is a C/C++ repo with vendored sources, I treated src/3rdparty/** as third-party and excluded it from typo fixing (and encoded that in the new .codespellrc).
Typos fixed (first-party only)
Docs
CHANGELOG.md: perfomance -> performance
doc/API.md: optionaly -> optionally, Offical -> Official
doc/BENCHMARK.md: parameteres -> parameters
doc/CPU.md: loosing -> losing, instuctions -> instructions
doc/CHANGELOG_OLD.md: multiple obvious text typos like Breaked -> Broken, singal -> signal, previos -> previous, secons -> seconds, automaticaly -> automatically, perfomance -> performance
Code comments / doc comments (safe text-only changes)
src/base/crypto/sha3.cpp: Inteface -> Interface (comment banner)
src/backend/opencl/cl/cn/cryptonight.cl: performe -> perform, crashs -> crashes (comments)
src/backend/opencl/cl/kawpow/kawpow.cl: regsters -> registers, intial -> initial (comments)
src/crypto/randomx/aes_hash.cpp: intial -> initial (comment)
src/crypto/randomx/intrin_portable.h: cant -> can't (comment)
src/crypto/randomx/randomx.h: intialization -> initialization (doc comment)
src/crypto/cn/c_jh.c: intital -> initial (comment)
src/crypto/cn/skein_port.h: varaiable -> variable (comment)
src/backend/opencl/cl/cn/wolf-skein.cl: Build-in -> Built-in (comment)
What I intentionally did NOT change
Anything under src/3rdparty/** (vendored).
A few remaining codespell hits are either:
Upstream/embedded sources we excluded (groestl256.cl, jh.cl contain Projet)
Potentially valid identifier/name (Carmel CPU codename)
Low-risk token in codegen comments (vor inside an instruction comment)
These are handled via ignore rules in .codespellrc instead of modifying code.

Added: .codespellrc
Created /.codespellrc with:

skip entries for vendored / embedded upstream areas:
./src/3rdparty
./src/crypto/ghostrider
./src/crypto/randomx/blake2
./src/crypto/cn/sse2neon.h
./src/backend/opencl/cl/cn/groestl256.cl
./src/backend/opencl/cl/cn/jh.cl
ignore-words-list for:
Carmel
vor
Verification
codespell . --config ./.codespellrc now exits clean (exit code 0).

Signed-off-by: rezky_nightky <with.rezky@gmail.com>
2026-01-21 20:14:59 +07:00
xmrig
2d52118c1b Merge pull request #2161 from coolhaircut/patch-1
Added Userspace MSR permissions clarification in CPU.md
2021-03-08 04:01:15 +07:00
Cool Dude (with a cool haircut)
542617b6db Update CPU.md 2021-03-05 22:54:03 +00:00
Felix Yan
32876dd01d Correct a typo in doc/CPU.md 2021-02-24 04:36:27 +08:00
xmrig
cffd0f50a4 Update CPU.md 2021-02-21 20:22:06 +07:00
SChernykh
f302b4b0ef Added documentation for config.json CPU options 2021-01-28 13:37:27 +01:00
XMRig
901f1a7ab1 Option "yield" enabled by default and added command line option --cpu-no-yield. 2019-12-04 08:50:54 +07:00
XMRig
58c81be1f1 Updated default config and docs. 2019-10-08 09:41:36 +07:00
xmrig
0eb5588454 Update CPU.md 2019-09-28 02:25:34 +07:00
xmrig
5ba8b43fb8 Update CPU.md 2019-09-28 02:25:00 +07:00
xmrig
0fde6ef57a Update CPU.md 2019-08-17 19:56:17 +07:00
xmrig
030a9622cf Update CPU.md 2019-08-17 14:05:36 +07:00
XMRig
97192f224d Changed CPU threads format. 2019-08-07 21:47:42 +07:00
XMRig
42dc914eec Added alternative object format for CPU threads. 2019-08-07 18:12:39 +07:00
xmrig
cc4351d49f Update CPU.md 2019-08-06 13:23:51 +07:00
xmrig
ef2454b025 Update CPU.md 2019-07-28 13:30:17 +07:00
xmrig
c7ba4f8f2f Update CPU.md 2019-07-20 23:33:04 +07:00
xmrig
7119e4c64c Update CPU.md 2019-07-20 23:23:13 +07:00
xmrig
83f0f2bcad Create CPU.md 2019-07-20 23:16:23 +07:00