diff --git a/docs/en/edge_computing/ros/_toc.yaml b/docs/en/edge_computing/ros/_toc.yaml index ba231fd05be58dd83cc67bf5b899b557116e1586..ea232ab4e64187cf00b3e5c7c7141c62a9ca3372 100644 --- a/docs/en/edge_computing/ros/_toc.yaml +++ b/docs/en/edge_computing/ros/_toc.yaml @@ -10,7 +10,5 @@ sections: href: ./installation_and_deployment.md - label: Usage href: ./usage_guide.md - - label: Common Issues and Solutions - href: ./faqs_and_solutions.md - label: Appendix href: ./appendix.md diff --git a/docs/en/edge_computing/ros/faqs_and_solutions.md b/docs/en/edge_computing/ros/faqs_and_solutions.md deleted file mode 100644 index f5933a9ead3745a027a0d2e32590438e052dd47c..0000000000000000000000000000000000000000 --- a/docs/en/edge_computing/ros/faqs_and_solutions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Common Issues and Solutions - -This document is currently not available in English. diff --git a/docs/en/server/_toc.yaml b/docs/en/server/_toc.yaml index 751e85c5a97ca8ed7bc5f103d69ff511a58522c4..cbd4030a8ed41b7c68b32a65d69f8ff6d6ace9a3 100644 --- a/docs/en/server/_toc.yaml +++ b/docs/en/server/_toc.yaml @@ -55,7 +55,7 @@ sections: - href: ./performance/cpu_optimization/kae/_toc.yaml - label: System Optimization sections: - - href: ./performance/system_optimzation/atune/_toc.yaml + - href: ./performance/system_optimization/atune/_toc.yaml - label: Application Development sections: - href: ./development/application_dev/_toc.yaml diff --git a/docs/en/server/performance/system_optimzation/atune/_toc.yaml b/docs/en/server/performance/system_optimization/atune/_toc.yaml similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/_toc.yaml rename to docs/en/server/performance/system_optimization/atune/_toc.yaml diff --git a/docs/en/server/performance/system_optimzation/atune/a_tune.md b/docs/en/server/performance/system_optimization/atune/a_tune.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/a_tune.md rename to docs/en/server/performance/system_optimization/atune/a_tune.md diff --git a/docs/en/server/performance/system_optimzation/atune/appendix.md b/docs/en/server/performance/system_optimization/atune/appendix.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/appendix.md rename to docs/en/server/performance/system_optimization/atune/appendix.md diff --git a/docs/en/server/performance/system_optimzation/atune/faqs_and_solutions.md b/docs/en/server/performance/system_optimization/atune/faqs_and_solutions.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/faqs_and_solutions.md rename to docs/en/server/performance/system_optimization/atune/faqs_and_solutions.md diff --git a/docs/en/server/performance/system_optimzation/atune/figures/picture1.png b/docs/en/server/performance/system_optimization/atune/figures/picture1.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/picture1.png rename to docs/en/server/performance/system_optimization/atune/figures/picture1.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/picture4.png b/docs/en/server/performance/system_optimization/atune/figures/picture4.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/picture4.png rename to docs/en/server/performance/system_optimization/atune/figures/picture4.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0213178479.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0213178479.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0213178479.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0213178479.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0213178480.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0213178480.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0213178480.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0213178480.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0214540398.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0214540398.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0214540398.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0214540398.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0227497000.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0227497000.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0227497000.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0227497000.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0227497343.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0227497343.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0227497343.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0227497343.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0231122163.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0231122163.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0231122163.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0231122163.png diff --git a/docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0245342444.png b/docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0245342444.png similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/figures/zh-cn_image_0245342444.png rename to docs/en/server/performance/system_optimization/atune/figures/zh-cn_image_0245342444.png diff --git a/docs/en/server/performance/system_optimzation/atune/getting_to_know_a_tune.md b/docs/en/server/performance/system_optimization/atune/getting_to_know_a_tune.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/getting_to_know_a_tune.md rename to docs/en/server/performance/system_optimization/atune/getting_to_know_a_tune.md diff --git a/docs/en/server/performance/system_optimzation/atune/installation_and_deployment.md b/docs/en/server/performance/system_optimization/atune/installation_and_deployment.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/installation_and_deployment.md rename to docs/en/server/performance/system_optimization/atune/installation_and_deployment.md diff --git a/docs/en/server/performance/system_optimzation/atune/native_turbo.md b/docs/en/server/performance/system_optimization/atune/native_turbo.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/native_turbo.md rename to docs/en/server/performance/system_optimization/atune/native_turbo.md diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-caution.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-caution.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-caution.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-caution.gif diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-danger.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-danger.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-danger.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-danger.gif diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-note.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-note.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-note.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-note.gif diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-notice.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-notice.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-notice.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-notice.gif diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-tip.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-tip.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-tip.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-tip.gif diff --git a/docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-warning.gif b/docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-warning.gif similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/public_sys-resources/icon-warning.gif rename to docs/en/server/performance/system_optimization/atune/public_sys-resources/icon-warning.gif diff --git a/docs/en/server/performance/system_optimzation/atune/usage_instructions.md b/docs/en/server/performance/system_optimization/atune/usage_instructions.md similarity index 100% rename from docs/en/server/performance/system_optimzation/atune/usage_instructions.md rename to docs/en/server/performance/system_optimization/atune/usage_instructions.md diff --git a/docs/en/tools/community_tools/_toc.yaml b/docs/en/tools/community_tools/_toc.yaml index d45d3b54a36acefa7e053e23c7bde194040d4b09..0e43327be4d9949db7a4f4ae7489045adcf3341a 100644 --- a/docs/en/tools/community_tools/_toc.yaml +++ b/docs/en/tools/community_tools/_toc.yaml @@ -15,4 +15,8 @@ sections: - href: ./epkg_use/_toc.yaml - label: Compilation sections: - - href: ./pin/_toc.yaml + - href: ../../server/development/gcc/_toc.yaml + - label: Performance Optomization + sections: + - href: ../../server/performance/system_optimization/atune/_toc.yaml + - href: ../../server/performance/tuning_framework/oeaware/_toc.yaml \ No newline at end of file diff --git a/docs/en/tools/community_tools/image_tailor/_toc.yaml b/docs/en/tools/community_tools/image_tailor/_toc.yaml index 9e7350413fa5d6e4caeee93a25ca1bfac5f8cda6..28992d35e1f4dc90fe53ffb3ec6f6820d459d578 100644 --- a/docs/en/tools/community_tools/image_tailor/_toc.yaml +++ b/docs/en/tools/community_tools/image_tailor/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: OS image tailoring by removing unneeded packages or files sections: - label: imageTailor User Guide - href: ./imagetailor_userguide.md + href: ./imagetailor_user_guide.md diff --git a/docs/en/tools/community_tools/image_tailor/imagetailor_userguide.md b/docs/en/tools/community_tools/image_tailor/imagetailor_user_guide.md similarity index 100% rename from docs/en/tools/community_tools/image_tailor/imagetailor_userguide.md rename to docs/en/tools/community_tools/image_tailor/imagetailor_user_guide.md diff --git a/docs/en/tools/community_tools/pin/_toc.yaml b/docs/en/tools/community_tools/pin/_toc.yaml deleted file mode 100644 index 754f09961c90b08c3583801407aaa646e96e2c55..0000000000000000000000000000000000000000 --- a/docs/en/tools/community_tools/pin/_toc.yaml +++ /dev/null @@ -1,6 +0,0 @@ -label: PIN User Guide -isManual: true -description: PIN User Guide -sections: - - label: PIN User Guide - href: ./pin_user_guide.md diff --git a/docs/en/tools/community_tools/pin/pin_user_guide.md b/docs/en/tools/community_tools/pin/pin_user_guide.md deleted file mode 100644 index bf2c81d17eb9659799533dd84af635362af18cee..0000000000000000000000000000000000000000 --- a/docs/en/tools/community_tools/pin/pin_user_guide.md +++ /dev/null @@ -1,134 +0,0 @@ -# Installation and Deployment - -## Software - -* OS: openEuler 24.03 - -## Hardware - -* x86_64 -* Arm - -## Preparing the Environment - -* Install the openEuler operating system. For details, see the [*openEuler Installation Guide*](../../../server/installation_upgrade/installation/installation_on_servers.md). - -### Install the dependency - -#### Installing the Software on Which the PIN GCC Client Depends - -```shell -yum install -y grpc -yum install -y grpc-devel -yum install -y grpc-plugins -yum install -y protobuf-devel -yum install -y jsoncpp -yum install -y jsoncpp-devel -yum install -y gcc-plugin-devel -yum install -y llvm-mlir -yum install -y llvm-mlir-devel -yum install -y llvm-devel -``` - -#### Installing the Software on Which the PIN Server Depends - -```shell -yum install -y grpc -yum install -y grpc-devel -yum install -y grpc-plugins -yum install -y protobuf-devel -yum install -y jsoncpp -yum install -y jsoncpp-devel -yum install -y llvm-mlir -yum install -y llvm-mlir-devel -yum install -y llvm-devel -``` - -## Installing PIN - -### rpmbuild - -#### Building the PIN GCC Client - -```shell -git clone https://gitee.com/src-openeuler/pin-gcc-client.git -cd pin-gcc-client -mkdir -p ~/rpmbuild/SOURCES -cp *.path pin-gcc-client.tar.gz ~/rpmbuild/SOURCES -rpmbuild -ba pin-gcc-client.spec -cd ~/rpmbuild/RPMS -rpm -ivh pin-gcc-client.rpm -``` - -#### Building the PIN Server - -```shell -git clone https://gitee.com/src-openeuler/pin-server.git -cd pin-server -mkdir -p ~/rpmbuild/SOURCES -cp *.path pin-server.tar.gz ~/rpmbuild/SOURCES -rpmbuild -ba pin-server.spec -cd ~/rpmbuild/RPMS -rpm -ivh pin-server.rpm -``` - -### Build - -#### Building the PIN GCC Client - -```shell -git clone https://gitee.com/openeuler/pin-gcc-client.git -cd pin-gcc-client -mkdir build -cd build -cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} -make -``` - -#### Building the PIN Server - -```shell -git clone https://gitee.com/openeuler/pin-server.git -cd pin-server -mkdir build -cd build -cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} -make -``` - -# Usage - -You can use `-fplugin` and `-fplugin-arg-libpin_xxx` to enable the Plug-IN (PIN) tool. -Command: - -```shell -$(TARGET): $(OBJS) - $(CXX) -fplugin=${CLIENT_PATH}/build/libpin_gcc_client.so \ - -fplugin-arg-libpin_gcc_client-server_path=${SERVER_PATH}/build/pin_server \ - -fplugin-arg-libpin_gcc_client-log_level="1" \ - -fplugin-arg-libpin_gcc_client-arg1="xxx" -``` - -You can use the `${INSTALL_PATH}/bin/pin-gcc-client.json` file to configure PIN. The configuration options are as follows: - -`path`: path of the executable file of the PIN server. - -`sha256file`: path of the PIN verification file `xxx.sha256`. - -`timeout`: timeout interval for cross-process communication, in milliseconds. - -Compile options: - -`-fplugin`: path of the .so file of the PIN client. - -`-fplugin-arg-libpin_gcc_client-server_path`: path of the executable program of the PIN server. - -`-fplugin-arg-libpin_gcc_client-log_level`: default log level. The value ranges from `0` to `3`. The default value is `1`. - -`-fplugin-arg-libpin_gcc_client-argN`: other parameters that can be specified as required. `argN` indicates the argument required by PIN. - -# Compatibility - -This section describes the compatibility issues in some special scenarios. This project is in continuous iteration and will be fixed as soon as possible. Developers are welcome to join this project. - -* When PIN is enabled in the `-flto` phase, multi-process compilation using `make -j` is not supported. You are advised to use `make -j1` for compilation. diff --git a/docs/en/tools/desktop/dde/_toc.yaml b/docs/en/tools/desktop/dde/_toc.yaml index dcef88c1ddebadf4fe4b4600eae62b663b823acf..7b9b081c20faa49ceb41e735d9673d10ee89de16 100644 --- a/docs/en/tools/desktop/dde/_toc.yaml +++ b/docs/en/tools/desktop/dde/_toc.yaml @@ -5,4 +5,4 @@ sections: - label: DDE Installation href: ./dde_installation.md - label: DDE User Guide - href: ./dde_userguide.md + href: ./dde_user_guide.md diff --git a/docs/en/tools/desktop/dde/dde_userguide.md b/docs/en/tools/desktop/dde/dde_user_guide.md similarity index 100% rename from docs/en/tools/desktop/dde/dde_userguide.md rename to docs/en/tools/desktop/dde/dde_user_guide.md diff --git a/docs/en/tools/desktop/gnome/_toc.yaml b/docs/en/tools/desktop/gnome/_toc.yaml index c8a203fc5b2b4f6dc7ad11544b6c6d6693e273f6..51b2fd03cd72879983196636267acbc23f7049e0 100644 --- a/docs/en/tools/desktop/gnome/_toc.yaml +++ b/docs/en/tools/desktop/gnome/_toc.yaml @@ -2,9 +2,7 @@ label: GNOME User Guide isManual: true description: Install and use GNOME. sections: - - label: GNOME - href: ./gnome.md - label: GNOME Installation href: ./gnome_installation.md - label: GNOME User Guide - href: ./gnome_userguide.md + href: ./gnome_user_guide.md diff --git a/docs/en/tools/desktop/gnome/gnome.md b/docs/en/tools/desktop/gnome/gnome.md deleted file mode 100644 index e620de95b58cd2c8bd4b46dc925d7b393a2ff00b..0000000000000000000000000000000000000000 --- a/docs/en/tools/desktop/gnome/gnome.md +++ /dev/null @@ -1,3 +0,0 @@ -# GNOME User Guide - -This chapter describes how to install and use the GNOME desktop environment. diff --git a/docs/en/tools/desktop/gnome/gnome_userguide.md b/docs/en/tools/desktop/gnome/gnome_user_guide.md similarity index 100% rename from docs/en/tools/desktop/gnome/gnome_userguide.md rename to docs/en/tools/desktop/gnome/gnome_user_guide.md diff --git a/docs/en/tools/desktop/kiran/_toc.yaml b/docs/en/tools/desktop/kiran/_toc.yaml index 91a3ca13b899de961a8d1ccfa9b933fa511a90d7..b690aa30b7fda6ae6112b1326693251de91cf0ca 100644 --- a/docs/en/tools/desktop/kiran/_toc.yaml +++ b/docs/en/tools/desktop/kiran/_toc.yaml @@ -2,9 +2,7 @@ label: Kiran User Guide isManual: true description: Install and use Kiran. sections: - - label: Kiran - href: ./kiran.md - label: Installing Kiran href: ./kiran_installation.md - label: Using Kiran - href: ./kiran_userguide.md + href: ./kiran_user_guide.md diff --git a/docs/en/tools/desktop/kiran/kiran.md b/docs/en/tools/desktop/kiran/kiran.md deleted file mode 100644 index b9da8f9fda119724e97d0f45f62a3b32ea80bbb8..0000000000000000000000000000000000000000 --- a/docs/en/tools/desktop/kiran/kiran.md +++ /dev/null @@ -1,3 +0,0 @@ -# Kiran User Guide - -This chapter describes how to install and use the Kiran desktop environment. diff --git a/docs/en/tools/desktop/kiran/kiran_userguide.md b/docs/en/tools/desktop/kiran/kiran_user_guide.md similarity index 100% rename from docs/en/tools/desktop/kiran/kiran_userguide.md rename to docs/en/tools/desktop/kiran/kiran_user_guide.md diff --git a/docs/en/tools/desktop/ukui/_toc.yaml b/docs/en/tools/desktop/ukui/_toc.yaml index 16134a0760d117da519e465b1ea69c129d28e38d..44c4f869af8760f0f4c1f5714a19a8e133f46ff1 100644 --- a/docs/en/tools/desktop/ukui/_toc.yaml +++ b/docs/en/tools/desktop/ukui/_toc.yaml @@ -2,9 +2,7 @@ label: UKUI User Guide isManual: true description: Install and use UKUI. sections: - - label: UKUI - href: ./ukui.md - label: Installing UKUI href: ./ukui_installation.md - label: Using UKUI - href: ./ukui_userguide.md + href: ./ukui_user_guide.md diff --git a/docs/en/tools/desktop/ukui/ukui.md b/docs/en/tools/desktop/ukui/ukui.md deleted file mode 100644 index 91fd9e42a5f32afea46998115147498fcc06d024..0000000000000000000000000000000000000000 --- a/docs/en/tools/desktop/ukui/ukui.md +++ /dev/null @@ -1,3 +0,0 @@ -# UKUI User Guide - -This chapter describes how to install and use the UKUI desktop environment. diff --git a/docs/en/tools/desktop/ukui/ukui_userguide.md b/docs/en/tools/desktop/ukui/ukui_user_guide.md similarity index 100% rename from docs/en/tools/desktop/ukui/ukui_userguide.md rename to docs/en/tools/desktop/ukui/ukui_user_guide.md