From e81a665f9b2a3f4676c9d73d81b96fd2215327b4 Mon Sep 17 00:00:00 2001 From: Dimitris Apostolou Date: Mon, 7 May 2018 22:23:00 +0300 Subject: [PATCH] Fix typos --- README.md | 2 +- doc/CONTRIBUTING.md | 2 +- doc/bisq-sn.cron.sh | 4 ++-- doc/bisq.conf | 2 +- doc/build.md | 2 +- doc/install_on_unix_fin.sh | 2 +- doc/protobuffer.md | 14 +++++++------- doc/rpc.md | 4 ++-- doc/ui-development-notes.md | 4 ++-- gradlew | 2 +- package/linux/32bitBuild.sh | 2 +- package/linux/64bitBuild.sh | 2 +- package/osx/Info.plist | 2 +- package/osx/create_app.sh | 2 +- package/windows/32bitBuild.bat | 2 +- package/windows/64bitBuild.bat | 2 +- src/main/java/bisq/desktop/SystemTray.java | 2 +- src/main/java/bisq/desktop/app/BisqApp.java | 4 ++-- 18 files changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 432209ba67..81ae481ce7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Status ------ Bisq has released the beta version on the 27th of April 2016. It is operational since that time without any major incident. Please follow the current development state at our [road map]( https://bisq.network/roadmap). -For the latest version checkout our [releases page](https://github.com/bisq-network/exchange/releases) at Github. +For the latest version checkout our [releases page](https://github.com/bisq-network/exchange/releases) at GitHub. Building from source -------------------- diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index d1026c1307..5fa654ad40 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -1,4 +1,4 @@ -Contributing to bisq +Contributing to Bisq ============================ Pull requests diff --git a/doc/bisq-sn.cron.sh b/doc/bisq-sn.cron.sh index f30a1462bf..ea80463422 100755 --- a/doc/bisq-sn.cron.sh +++ b/doc/bisq-sn.cron.sh @@ -1,5 +1,5 @@ #!/bin/sh -# Restart bisq seed node daemons whose resident memory (RSS) +# Restart Bisq seed node daemons whose resident memory (RSS) # is over MAX_RSS_MiB. # # Scripts in the INITDIR must contain a ``SN_ADDRESS=`` @@ -13,7 +13,7 @@ MAX_RSS_MiB=400 PIDDIR=/var/run/bisq-sn INITDIR=/etc/init.d -# Restart de daemon with the given address. +# Restart the daemon with the given address. restart() { rcscript=$(grep -El "^SN_ADDRESS=['\"]?$1['\"]?" $INITDIR/*) if [ "$rcscript" ]; then diff --git a/doc/bisq.conf b/doc/bisq.conf index bf4be0f4f2..f560a9c44e 100644 --- a/doc/bisq.conf +++ b/doc/bisq.conf @@ -2,7 +2,7 @@ # Here are the typical locations for the data directory: -# Mac OSX: /Users/username/Library/Application Support/bisq/ +# macOS: /Users/username/Library/Application Support/bisq/ # Linux: /home/username/.bisq/ # Windows XP: C:\Documents and Settings\username\Application Data\bisq\ # Windows Vista or 7: %appdata%/bisq/ diff --git a/doc/build.md b/doc/build.md index 882104b80f..d8abf4f497 100644 --- a/doc/build.md +++ b/doc/build.md @@ -103,7 +103,7 @@ If you want to build the binaries check out the build scripts under the package DAO full node ----------------- If you want to run your own BSQ transaction verification node you have to run Bitcoin Core with RPC enabled and -use dedicated program arguments for the bisq node. +use dedicated program arguments for the Bisq node. See https://github.com/bisq-network/bisq-desktop/blob/master/doc/rpc.md for more details. diff --git a/doc/install_on_unix_fin.sh b/doc/install_on_unix_fin.sh index f52df091d5..f046217934 100755 --- a/doc/install_on_unix_fin.sh +++ b/doc/install_on_unix_fin.sh @@ -10,7 +10,7 @@ JAVA_HOME=/usr/lib/jvm/java-8-oracle # and add JAVA_HOME to .bashrc # export JAVA_HOME=/usr/lib/jvm/java-8-oracle -echo "Install bisq" +echo "Install Bisq" cd ~/bisq ./gradlew build cd .. diff --git a/doc/protobuffer.md b/doc/protobuffer.md index bb1415316b..bf84bbbb6c 100644 --- a/doc/protobuffer.md +++ b/doc/protobuffer.md @@ -6,25 +6,25 @@ NOTE: this doc is out of date and should probably be deleted. Protobuffer stuff Protobuffer is installed automatically via the Gradle build. -## Why protobuffer? +## Why Protobuffer? There are a number of reasons why protobuffer was chosen, here are some of them: * avoids java serialisation security issues * smaller in size than java serialisation (less network usage) -* All P2P network messages are described in a clear protobuffer schema +* All P2P network messages are described in a clear Protobuffer schema * allows to evolve your schema in a backward compatible way * can generate code in many languages, making alternative bisq clients or monitoring tools easier -## Which classes are transformed to protobuffer? +## Which classes are transformed to Protobuffer? All classes in the 'wire' module. This module contains the following classes: * classes sent over the wire (P2P network) * classes serialized to disk -## Where are the protobuffer related files? +## Where are the Protobuffer related files? -The protobuffer schema file(s), generated classes and domain classes are in the 'wire' module. +The Protobuffer schema file(s), generated classes and domain classes are in the 'wire' module. Look for *.proto for the schema files. ## How is serialisation done (Java -> Protobuffer) @@ -36,7 +36,7 @@ Some interfaces have a 'toProtobuf' method to force all extending classes to imp Some interfaces have a 'toProtobuf' method to force all extending classes to implement that method. -## If fields are not filled in, what are protobuffer's default values? +## If fields are not filled in, what are Protobuffer's default values? Read this very carefully: @@ -82,7 +82,7 @@ https://ruedigermoeller.github.io/fast-serialization/ * Try to use value objects for data which gets serialized with PB * Use toProto and a static fromProto in the class which gets serialized * Use proto as name for the PB param in the fromProto method -* If a constructor is used only for PB make it private and put it to the PB section, so its clear it is used only in that context +* If a constructor is used only for PB make it private and put it to the PB section, so it's clear it is used only in that context * Use same name for classes and fields in PB definition as in the java code base * Use final * Use Lombok Annotations diff --git a/doc/rpc.md b/doc/rpc.md index f4f2b208be..27219a2eed 100644 --- a/doc/rpc.md +++ b/doc/rpc.md @@ -20,7 +20,7 @@ For mainnet: --fullDaoNode=true --rpcUser=bisq --rpcPassword=bisqPW --rpcPort=8332 --rpcBlockNotificationPort=4159 If you use mainnet it is recommended to use a Bitcoin node with no funds in the wallet to avoid security risks when -enabling rpc or take sufficient precautions from your network setup. +enabling RPC or take sufficient precautions from your network setup. In the bitcoin.conf file you need to set txindex=1. That causes a re-index of the whole data base which takes considerable time with a @@ -31,6 +31,6 @@ If you want to dump the blockchain data to json add: --dumpBlockchainData=true ( If you use RegTest in development environment you need to create the genesis transaction. Create one Bitcoin transaction from Bitcoin Core to one or 2 Bisq instances using the BSQ receive addresses from those apps (1 tx with 2 or more outputs to the Bisq app). If you copy the BSQ address and use that in Bitcoin Core you need to remove the "B" at the beginning. This is only for protection to mix up BTC and BSQ addresses but without the B it is a native Bitcoin address. -Create one block with the debug commandline inside Bitcoin Core (generate 1). Look up the block height in the info screen in the debug window. +Create one block with the debug command line inside Bitcoin Core (generate 1). Look up the block height in the info screen in the debug window. Set the block height and transaction ID at BsqBlockChain.BTC_REG_TEST_GENESIS_TX_ID and BsqBlockChain.BTC_REG_TEST_GENESIS_BLOCK_HEIGHT. Restart the Bisq apps. After that the app will recognize the received Bitcoin as BSQ. diff --git a/doc/ui-development-notes.md b/doc/ui-development-notes.md index d81b7406a1..fbc934b2a7 100644 --- a/doc/ui-development-notes.md +++ b/doc/ui-development-notes.md @@ -1,4 +1,4 @@ -## UI Architecure pattern: +## UI Architecture pattern: We use a variant of the **Presentation Model** pattern which has some similarities with the **Model View ViewModel** (MVVM used in Silverlight and WPF) as we use data bindings, though there are differences in the way the view and the "code behind" is organized (due to different framework features/support). @@ -25,7 +25,7 @@ For prototyping the UI we stick first with a more rapid development style approa * View/CB is responsible for the visual representation. No logic. No state. * Presentation model holds the view/CB state. * Presentation model handles view specific logic. -* Presentation model does validation of user in put and formatting of domain data. +* Presentation model does validation of user input and formatting of domain data. * Model is the domain specific representation of the view. It holds domain data and handles domain logic. diff --git a/gradlew b/gradlew index cccdd3d517..e98ff45716 100755 --- a/gradlew +++ b/gradlew @@ -164,7 +164,7 @@ APP_ARGS=$(save "$@") # Collect all arguments for the java command, following the shell quoting and substitution rules eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +# by default we should be in the correct project dir, but when run from Finder on macOS, the cwd is wrong if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then cd "$(dirname "$0")" fi diff --git a/package/linux/32bitBuild.sh b/package/linux/32bitBuild.sh index 8cede5c50e..8633acf350 100644 --- a/package/linux/32bitBuild.sh +++ b/package/linux/32bitBuild.sh @@ -10,7 +10,7 @@ version=0.6.7 dir="/media/sf_vm_shared_ubuntu14_32bit" -# Note: fakeroot needs to be installed on linux +# Note: fakeroot needs to be installed on Linux $JAVA_HOME/bin/javapackager \ -deploy \ -Bruntime="$JAVA_HOME/jre" \ diff --git a/package/linux/64bitBuild.sh b/package/linux/64bitBuild.sh index 7745625c20..ec395492e5 100644 --- a/package/linux/64bitBuild.sh +++ b/package/linux/64bitBuild.sh @@ -10,7 +10,7 @@ version=0.6.7 dir="/media/sf_vm_shared_ubuntu" -# Note: fakeroot needs to be installed on linux +# Note: fakeroot needs to be installed on Linux $JAVA_HOME/bin/javapackager \ -deploy \ -Bruntime="$JAVA_HOME/jre" \ diff --git a/package/osx/Info.plist b/package/osx/Info.plist index 0be828bf28..c73b7ef712 100644 --- a/package/osx/Info.plist +++ b/package/osx/Info.plist @@ -22,7 +22,7 @@ APPL CFBundleShortVersionString 1 - + CFBundleSignature ???? LSApplicationCategoryType diff --git a/package/osx/create_app.sh b/package/osx/create_app.sh index 82c3b2b1b3..68179348f5 100755 --- a/package/osx/create_app.sh +++ b/package/osx/create_app.sh @@ -21,7 +21,7 @@ cp build/libs/bisq-desktop.jar "deploy/Bisq-$version.jar" # copy app jar to VM shared folders cp build/libs/bisq-desktop.jar "$linux32/Bisq-$version.jar" cp build/libs/bisq-desktop.jar "$linux64/Bisq-$version.jar" -# At windows we don't add the version nr as it would keep multiple versions of jar files in app dir +# On Windows we don't add the version nr as it would keep multiple versions of jar files in app dir cp build/libs/bisq-desktop.jar "$win32/Bisq.jar" cp build/libs/bisq-desktop.jar "$win64/Bisq.jar" diff --git a/package/windows/32bitBuild.bat b/package/windows/32bitBuild.bat index 083e12bd27..a0400782bf 100644 --- a/package/windows/32bitBuild.bat +++ b/package/windows/32bitBuild.bat @@ -1,4 +1,4 @@ -:: Invoke from bisq home directory +:: Invoke from Bisq home directory :: edit iss file -> AppVersion :: edit -> -BappVersion and -srcfiles diff --git a/package/windows/64bitBuild.bat b/package/windows/64bitBuild.bat index 2ae1adf270..f4f107609c 100644 --- a/package/windows/64bitBuild.bat +++ b/package/windows/64bitBuild.bat @@ -1,4 +1,4 @@ -:: Invoke from bisq home directory +:: Invoke from Bisq home directory :: edit iss file -> AppVersion :: edit -> -BappVersion and -srcfiles diff --git a/src/main/java/bisq/desktop/SystemTray.java b/src/main/java/bisq/desktop/SystemTray.java index f0ba4d0021..14baac9942 100644 --- a/src/main/java/bisq/desktop/SystemTray.java +++ b/src/main/java/bisq/desktop/SystemTray.java @@ -106,7 +106,7 @@ public class SystemTray { BufferedImage trayIconImage = ImageIO.read(getClass().getResource(path)); TrayIcon trayIcon = new TrayIcon(trayIconImage); // On Windows and Linux the icon needs to be scaled - // On OSX we get the correct size from the provided image + // On macOS we get the correct size from the provided image if (!Utilities.isOSX()) { int trayIconWidth = trayIcon.getSize().width; trayIcon = new TrayIcon(trayIconImage.getScaledInstance(trayIconWidth, -1, Image.SCALE_SMOOTH)); diff --git a/src/main/java/bisq/desktop/app/BisqApp.java b/src/main/java/bisq/desktop/app/BisqApp.java index 57a0efeee8..16b2317e5f 100644 --- a/src/main/java/bisq/desktop/app/BisqApp.java +++ b/src/main/java/bisq/desktop/app/BisqApp.java @@ -161,7 +161,7 @@ public class BisqApp extends Application implements UncaughtExceptionHandler { public void handleUncaughtException(Throwable throwable, boolean doShutDown) { if (!shutDownRequested) { if (scene == null) { - log.warn("Scene not available yet, we create a new scene. The bug might be caused by an exception in a constructor or by a circular dependency in guice. throwable=" + throwable.toString()); + log.warn("Scene not available yet, we create a new scene. The bug might be caused by an exception in a constructor or by a circular dependency in Guice. throwable=" + throwable.toString()); scene = new Scene(new StackPane(), 1000, 650); scene.getStylesheets().setAll( "/bisq/desktop/bisq.css", @@ -225,7 +225,7 @@ public class BisqApp extends Application implements UncaughtExceptionHandler { stage.setMinWidth(1020); stage.setMinHeight(620); - // on windows the title icon is also used as task bar icon in a larger size + // on Windows the title icon is also used as task bar icon in a larger size // on Linux no title icon is supported but also a large task bar icon is derived from that title icon String iconPath; if (Utilities.isOSX())