From 9bc0aad82b30a7c02b0418771115c414d89e1aa2 Mon Sep 17 00:00:00 2001
From: huayu <huayu9@huawei.com>
Date: Tue, 16 Dec 2025 14:27:01 +0800
Subject: [PATCH] urpc: add doc to describe how to compile uRPC

---
 doc/ch/urpc/URPC User Guide.ch.md | 31 +++++++++++++++++++++++--------
 doc/en/urpc/URPC User Guide.md    | 28 +++++++++++++++++++++-------
 2 files changed, 44 insertions(+), 15 deletions(-)

diff --git a/doc/ch/urpc/URPC User Guide.ch.md b/doc/ch/urpc/URPC User Guide.ch.md
index eb16e01..921668a 100644
--- a/doc/ch/urpc/URPC User Guide.ch.md	
+++ b/doc/ch/urpc/URPC User Guide.ch.md	
@@ -2,17 +2,32 @@
 统一远程过程调用，支持灵衢原生高性能主机间和设备间RPC通信，以及RPC加速。
 
 # 2. 软件编译
-使用RPM包编译构建
-- rm -rf .git*
-- mkdir -p /root/rpmbuild/SOURCES/
-- tar -cvf /root/rpmbuild/SOURCES/umdk-25.12.0.tar.gz --exclude=.git $(ls -A)
-- rpmbuild -bb umdk.spec --with urpc
+
+## 使用RPM包编译构建
+```bash
+rm -rf .git*
+mkdir -p /root/rpmbuild/SOURCES/
+tar -cvf /root/rpmbuild/SOURCES/umdk-25.12.0.tar.gz --exclude=.git $(ls -A)
+rpmbuild -bb umdk.spec --with urpc
+```
+
+## 使用cmake编译uRPC
+```bash
+cd src
+mkdir build; cd build
+cmake .. -DBUILD_ALL=disable -DBUILD_URPC=enable
+make -j16
+make install # 可选项，如果需要安装uRPC则执行此命令
+```
 
 # 3. 安装使用
 - rpm -ivh /root/rpmbuild/RPMS/aarch64/umdk-urpc-*.rpm
 - urpc_framework_example -i SERVER_IP -d DEV_NAME -T 1 -e 0 --server --eid EID -L --assign_mode 2 -R
 - urpc_framework_example -i SERVER_IP -d DEV_NAME -T 1 -e 0 --client --eid EID -L --assign_mode 2 -R
 
-指令样例:
-- urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --server --eid 4245:4944:0000:0000:0000:0000:0100:0000 -L --assign_mode 2 -R
-- urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --client --eid 4245:4944:0000:0000:0000:0000:0200:0000 -L --assign_mode 2 -R
\ No newline at end of file
+**指令样例**:
+
+```bash
+urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --server --eid 4245:4944:0000:0000:0000:0000:0100:0000 -L --assign_mode 2 -R
+urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --client --eid 4245:4944:0000:0000:0000:0000:0200:0000 -L --assign_mode 2 -R
+```
\ No newline at end of file
diff --git a/doc/en/urpc/URPC User Guide.md b/doc/en/urpc/URPC User Guide.md
index 297cf6a..be611a6 100644
--- a/doc/en/urpc/URPC User Guide.md	
+++ b/doc/en/urpc/URPC User Guide.md	
@@ -2,11 +2,23 @@
 Provides a high-performance RPC communication library with extremely low latency, ultra-high IOPS, and massive bandwidth.
 
 # 2. Software Build
-Build and install RPM packages:
-- rm -rf .git*
-- mkdir -p /root/rpmbuild/SOURCES/
-- tar -cvf /root/rpmbuild/SOURCES/umdk-25.12.0.tar.gz --exclude=.git $(ls -A)
-- rpmbuild -bb umdk.spec --with urpc
+
+## Build and install RPM packages
+```bash
+rm -rf .git*
+mkdir -p /root/rpmbuild/SOURCES/
+tar -cvf /root/rpmbuild/SOURCES/umdk-25.12.0.tar.gz --exclude=.git $(ls -A)
+rpmbuild -bb umdk.spec --with urpc
+```
+
+## Complie uRPC with cmake
+```bash
+cd src
+mkdir build; cd build
+cmake .. -DBUILD_ALL=disable -DBUILD_URPC=enable
+make -j16
+make install # optional, install uRPC if needed
+```
 
 # 3. Usage Guide
 - rpm -ivh /root/rpmbuild/RPMS/aarch64/umdk-urpc-*.rpm
@@ -14,5 +26,7 @@ Build and install RPM packages:
 - urpc_framework_example -i SERVER_IP -d DEV_NAME -T 1 -e 0 --client --eid EID -L --assign_mode 2 -R
 
 example:
-- urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --server --eid 4245:4944:0000:0000:0000:0000:0100:0000 -L --assign_mode 2 -R
-- urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --client --eid 4245:4944:0000:0000:0000:0000:0200:0000 -L --assign_mode 2 -R
\ No newline at end of file
+```bash
+urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --server --eid 4245:4944:0000:0000:0000:0000:0100:0000 -L --assign_mode 2 -R
+urpc_framework_example -i 192.168.100.100 -d udma0 -T 1 -e 0 --client --eid 4245:4944:0000:0000:0000:0000:0200:0000 -L --assign_mode 2 -R
+```
\ No newline at end of file
-- 
Gitee