[Doc] Fix typo in md files
authorJunhwan Kim <jejudo.kim@samsung.com>
Tue, 30 Mar 2021 06:28:34 +0000 (15:28 +0900)
committerjaeyun-jung <39614140+jaeyun-jung@users.noreply.github.com>
Tue, 30 Mar 2021 07:27:14 +0000 (16:27 +0900)
Typo correction in md files.

Signed-off-by: Junhwan Kim <jejudo.kim@samsung.com>
CONTRIBUTING.md
Documentation/coding-convention.md
Documentation/component-description.md
Documentation/data-type-and-flow-control.md
Documentation/getting-started-android.md
Documentation/getting-started-ubuntu-ppa.md
Documentation/writing-subplugin-tensor-filter.md

index 346c478..e93e5a4 100644 (file)
@@ -6,7 +6,7 @@ title: Contributing
 
 Technical Steering Committee (TSC) is responsible for overseeing all technical aspects of the project, NNStreamer, and its subsidiary projects in the same Github organization.
 
-The initial TSC voting members are the committers of NNStreamer at the time of the first TSC meeting. Election or removal of TSC voting members should be approved by TSC voting. Except for approvals of license exceptions and the community charger amendments, approval of TCS voting requires approvals of more than half of present TSC voting members in a TSC meeting, which requires to have at least the half of the voting members present in the TSC meeting. Approvals of electronic TSC voting requires approvals of more than half of all TSC voting members. TSC may elect or replace the chairperson of the project with TSC voting.
+The initial TSC voting members are the committers of NNStreamer at the time of the first TSC meeting. Election or removal of TSC voting members should be approved by TSC voting. Except for approvals of license exceptions and the community charger amendments, approval of TSC voting requires approvals of more than half of present TSC voting members in a TSC meeting, which requires to have at least the half of the voting members present in the TSC meeting. Approvals of electronic TSC voting requires approvals of more than half of all TSC voting members. TSC may elect or replace the chairperson of the project with TSC voting.
 
 With unresolvable issues with TSC voting, a TSC voting member may inquire about the issues to the Linux Foundation Series managers.
 
index 21b6b55..5010487 100644 (file)
@@ -65,7 +65,7 @@ However, please try to stick with the same indentation rules (2 spaces) and comm
 
 ## Related git repositories
 
-- [NNStreamer Examplie Applications \& Documents](https://github.com/nnstreamer/nnstreamer-example)
+- [NNStreamer Example Applications \& Documents](https://github.com/nnstreamer/nnstreamer-example)
 - [TAOS-CI, CI Service for On-Device AI Systems](https://github.com/nnstreamer/TAOS-CI)
 - [NNStreamer ROS (Robot OS) Support](https://github.com/nnstreamer/nnstreamer-ros)
 - [NNStreamer Android Build Resource](https://github.com/nnstreamer/nnstreamer-android-resource): additional files required by Android builds.
index 42443fa..1e46a79 100644 (file)
@@ -35,7 +35,7 @@ In this page, we focus on the status of each elements. For requirements and desi
 - [tensor\_filter](https://github.com/nnstreamer/nnstreamer/tree/main/gst/nnstreamer/tensor_filter)
   - Main (stable)
     - Supported features
-      - Fixed input/ouput dimensions (fixed by subplugin)
+      - Fixed input/output dimensions (fixed by subplugin)
       - Flexible dimensions (output dimension determined by subplugin according to the input dimension determined by pipeline initialization)
       - Invoke subplugin with pre-allocated buffers
       - Invoke subplugin and let subplugin allocate output buffers.
@@ -129,7 +129,7 @@ Note that test elements in /tests/ are not elements for applications. They exist
 - Examples: Example GStreamer applications using NNStreamer and example sub-plugins for NNStreamer. The binaries from this directory is not supposed to be packaged with the main binary package.
   - [Example GStreamer applications](https://github.com/nnstreamer/nnstreamer-example)
   - [Example sub-plugins](https://github.com/nnstreamer/nnstreamer/tree/main/nnstreamer_example)
-- Packaing for Distros / SW-Platform Compatibility.
+- Packaging for Distros / SW-Platform Compatibility.
   - [Tizen](https://github.com/nnstreamer/nnstreamer/tree/main/packaging) (stable): RPM packaging for Tizen 5.0+. It is expected to be compatible with other RPM-based distros; however, it is not tested or guaranteed.
   - [Ubuntu](https://github.com/nnstreamer/nnstreamer/tree/main/debian) (stable): DEB packaging for Ubuntu 16.04. It is highly expected to be compatible with later versions as well; but, not tested yet. Debian is not tested, either.
   - [Yocto](https://github.com/nnsuite/meta-nerual-network) (stable)
index 43c9146..47dde7c 100644 (file)
@@ -97,9 +97,9 @@ We have the following principles for timestamp policies. Timestamping policies o
 \r
 ## Synchronization of frames in sink pads with Mux and Merge\r
 \r
-Besides timestamping, we have additional synchronization issues when there are merging streams. We need to determine which frames are going to be merged (or muxed) when we have multiple available and unused frames in an incoming sink pad. In general, we might say that the synchronization of frames determines which frames to be used for mux/merge and timestamping rule determins which timestamp to be used among the chosen frames for mux/merge.  \r
+Besides timestamping, we have additional synchronization issues when there are merging streams. We need to determine which frames are going to be merged (or muxed) when we have multiple available and unused frames in an incoming sink pad. In general, we might say that the synchronization of frames determines which frames to be used for mux/merge and timestamping rule determines which timestamp to be used among the chosen frames for mux/merge.  \r
 In principle and by default,\r
-- If there are mutliple unused and available frames in a sink pad, unlike most media filters, we take a buffer that arrived most recently.\r
+- If there are multiple unused and available frames in a sink pad, unlike most media filters, we take a buffer that arrived most recently.\r
 - For more about the synchronization policies, see [Synchronization policies at Mux and Merge](synchronization-policies-at-mux-merge.md)\r
 \r
 ### Leaky Queue\r
@@ -118,4 +118,4 @@ This is an obvious case. The timestamp is copied to all source pads from the sin
 ## Synchronization with Aggregator\r
 Unlike mux and merge, aggregator merges tensors chronologically, not spatially.  \r
 Moreover, unlike mux and merge, which merges entries into one entry, aggregator, depending on the properties, may divide or even simultaneously merge and divide entries. Thus, timestamping and synchronization may become much more complicated.  \r
-The timestamp of the outging buffer is timestamp of the oldest frame from the aggregated frames.\r
+The timestamp of the outgoing buffer is timestamp of the oldest frame from the aggregated frames.\r
index 4d28b7c..d5cd1a0 100644 (file)
@@ -311,7 +311,7 @@ With scoped storage, consider either options below:
     * (If your app targets API level 30 (Android 11) or later) Set `android:preserveLegacyExternalStorage="true"` in your `AndroidManifest.xml` to use the deprecated method `getExternalStorageDirectory`.
     * Use method `getExternalStorageDirectory` to get the File object.
     * Use the File object with NNStreamer Java API.
-    * **Note:** Use this option only for test purporse. This assumes that the model files should be in the right hardcoded path in the target device.
+    * **Note:** Use this option only for test purpose. This assumes that the model files should be in the right hardcoded path in the target device.
 
     Code example:
 
index 108b059..c23365e 100644 (file)
@@ -35,12 +35,12 @@ $ sudo apt install nnstreamer
 
 #### Safe method (need rebuild)
 
-You need to rebuild nnstreamer's corresponding subplugins (e.g., nnstreamer-tensorflow) with the nerual network framework version you want to use.
+You need to rebuild nnstreamer's corresponding subplugins (e.g., nnstreamer-tensorflow) with the neural network framework version you want to use.
 
 * You may configure/update, build with pdebuild/debuild, and install its resulting .deb packages [Ubuntu: Pbuilder / Pdebuild](getting-started-ubuntu-debuild.md).
-* You may configure/update, build with meson/ninja, and install binraies with ninja [Linux generic: build with meson and ninja](getting-started-meson-build.md): For advanced users with feature customization.
+* You may configure/update, build with meson/ninja, and install binaries with ninja [Linux generic: build with meson and ninja](getting-started-meson-build.md): For advanced users with feature customization.
 * Be careful on install paths and duplicated installation. You need to check the configuration (/etc/nnstreamer.ini and env-vars)
 
 #### Unsafe method (no need for rebuild)
 
-Try to let prebuilt nnstreamer binraies use another versions of tensorflow/pytorch installed. Theoretically, it should work by simply replacing tensorflow/pytorch with different versions. Unless symbols and their semantics are chnaged, it should work. (but that happens often with neural network frameworks, which are still not that stable.)
+Try to let prebuilt nnstreamer binaries use another versions of tensorflow/pytorch installed. Theoretically, it should work by simply replacing tensorflow/pytorch with different versions. Unless symbols and their semantics are changed, it should work. (but that happens often with neural network frameworks, which are still not that stable.)
index 15333e7..e7bafa2 100644 (file)
@@ -78,7 +78,7 @@ $ ls $TEMPLATE_DIR
 nnstreamer-test.ini.in  subplugin_unittest_template.cc.in
 ```
 
-There are two test template provided. One is conf file for the test enviornment, and the other is for the basic unittests (requires gtest).
+There are two test template provided. One is conf file for the test environment, and the other is for the basic unittests (requires gtest).
 
 List of variables that needs to be provided are provided below...
 | File                              | Variables                                                                                                                            |