Skip to content

Commit

Permalink
clear doc errors and check doc error during build
Browse files Browse the repository at this point in the history
Change-Id: I24b883b8e541732097d366087035a76b4b8f25d3
  • Loading branch information
charlesxzb authored and luluman committed Feb 23, 2024
1 parent 7cde80d commit eadac2d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
8 changes: 6 additions & 2 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,13 @@ cpu_num=`cat /proc/stat | grep cpu[0-9] -c`
cmake --build $BUILD_PATH --target install -j${cpu_num}

# Clean up some files for release build
if [ "$1" = "RELEASE" ]; then
if [ "$1" != "DEBUG" ]; then
# build doc
./release_doc.sh
./release_doc.sh > doc.log 2>&1
if grep -i 'error' doc.log; then
exit 1
fi

# strip mlir tools
pushd $INSTALL_PATH
find ./ -name "*.so" ! -name "*_kernel_module.so" ! -name "*_atomic_kernel.so" | xargs strip
Expand Down
3 changes: 2 additions & 1 deletion docs/developer_manual/source_en/12_codegen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Backend `store_cmd`
The function `store_cmd` in the backend refers to the process where the compiler calls the operators and saves the configured instructions to the designated space.
The key function in the backend is in `store_cmd.cpp`; for example, `cmodel/src/store_cmd.cpp`; `cmodel/include/store_cmd.h`.
`store_cmd` has a series of EngineStorer and CmdStorer classes:

1. EngineStoreInterface (interface class), GDMAEngineStorer, BDEngineStorer and other specific classes that inherit from the EngineStoreInterface interface, EngineStorerDecorator (decoration class interface),
VectorDumpEngineStorerDecorator and other specific decoration classes that inherit from EngineStorerDecorator
2. CmdStorerInterface (interface), ConcretCmdStorer inherited from the interface, StorerDecorator: decoration interface, VectorDumpStorerDecorator specific decoration class.
Expand Down Expand Up @@ -132,7 +133,7 @@ Relationship and Logic Among the Classes:
}
2. The function of 'EngineStorer' is to parse commands. 'VectorDumpEngineStorerDecorator' executes the 'store' function and 'take_cmds' function in the 'EngineStorer' class to store all instructions in 'output_'.
2. The function of 'EngineStorer' is to parse commands. 'VectorDumpEngineStorerDecorator' executes the 'store' function and 'take_cmds' function in the 'EngineStorer' class to store all instructions in `output_`.


.. code-block:: cpp
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_operation.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def add_item(self, row):
:arg row: list of items in the table.
"""
self.children.append([txt for txt in row])
self.children.append([("`" + txt + "`" if txt else txt) for txt in row])

def __repr__(self):
def print_table(header):
Expand Down

0 comments on commit eadac2d

Please sign in to comment.