[doc] format

This commit is contained in:
Kyle Chuang 2023-08-22 15:46:49 +08:00
parent 37ed10919f
commit dde9ef0449
6 changed files with 77 additions and 77 deletions

View File

@ -165,7 +165,7 @@ else ()
"-Wcast-align" #Warn if a cast causes memory alignment changes "-Wcast-align" #Warn if a cast causes memory alignment changes
"-Wshadow" #Warn if local variable shadows another variable "-Wshadow" #Warn if local variable shadows another variable
"-Wformat=2" #Sanity checks for printf-like formatting "-Wformat=2" #Sanity checks for printf-like formatting
"-Wno-format-nonliteral" # But don't worry about non-literal formtting (i.e. run-time printf format strings) "-Wno-format-nonliteral" # But don't worry about non-literal formatting (i.e. run-time printf format strings)
"-Wlogical-op" #Checks for logical op when bit-wise expected "-Wlogical-op" #Checks for logical op when bit-wise expected
"-Wmissing-declarations" #Warn if a global function is defined with no declaration "-Wmissing-declarations" #Warn if a global function is defined with no declaration
"-Wmissing-include-dirs" #Warn if a user include directory is missing "-Wmissing-include-dirs" #Warn if a user include directory is missing
@ -183,10 +183,10 @@ else ()
"-Wduplicated-cond" #Warn about identical conditions in if-else chains "-Wduplicated-cond" #Warn about identical conditions in if-else chains
"-Wduplicated-branches" #Warn when different branches of an if-else chain are equivalent "-Wduplicated-branches" #Warn when different branches of an if-else chain are equivalent
"-Wnull-dereference" #Warn about null pointer dereference execution paths "-Wnull-dereference" #Warn about null pointer dereference execution paths
"-Wuninitialized" #Warn about unitialized values "-Wuninitialized" #Warn about uninitialized values
"-Winit-self" #Warn about self-initialization "-Winit-self" #Warn about self-initialization
"-Wcatch-value=3" #Warn when catch statements don't catch by reference "-Wcatch-value=3" #Warn when catch statements don't catch by reference
"-Wextra-semi" #Warn about redudnant semicolons "-Wextra-semi" #Warn about redundant semicolons
"-Wimplicit-fallthrough=3" #Warn about case fallthroughs, but allow 'fallthrough' comments to suppress warnings "-Wimplicit-fallthrough=3" #Warn about case fallthroughs, but allow 'fallthrough' comments to suppress warnings
#GCC-like optional #GCC-like optional
#"-Wsuggest-final-types" #Suggest where 'final' would help if specified on a type methods #"-Wsuggest-final-types" #Suggest where 'final' would help if specified on a type methods
@ -201,7 +201,7 @@ else ()
#"-Wunsafe-loop-optimizations" #Warn when loops can't be optimized #"-Wunsafe-loop-optimizations" #Warn when loops can't be optimized
#"-Wswitch-enum" #Warn about uncovered enumeration values in a switch (even if there is a default) #"-Wswitch-enum" #Warn about uncovered enumeration values in a switch (even if there is a default)
#"-Wsign-promo" #Warn when overload resolution converts an unsigned type to signed when an unsigned overload exists #"-Wsign-promo" #Warn when overload resolution converts an unsigned type to signed when an unsigned overload exists
#"-Wdouble-promotion" #Warn when float is implicitly propted to double #"-Wdouble-promotion" #Warn when float is implicitly prompted to double
#"-Wuseless-cast" #Warn about casts to the same type #"-Wuseless-cast" #Warn about casts to the same type
#"-Wzero-as-null-pointer-constant" #Warn about using '0' instead of nullptr #"-Wzero-as-null-pointer-constant" #Warn about using '0' instead of nullptr
) )

View File

@ -24,7 +24,7 @@ CMAKE_BUILD_TYPE := $(shell echo ${BUILD_TYPE} | sed 's/_\?pgo//' | sed 's/_\?st
# e.g. make CMAKE_FLAGS="-DCMAKE_CXX_COMPILER=g++-9' # e.g. make CMAKE_FLAGS="-DCMAKE_CXX_COMPILER=g++-9'
override CMAKE_FLAGS := -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -G 'Unix Makefiles' ${CMAKE_FLAGS} override CMAKE_FLAGS := -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -G 'Unix Makefiles' ${CMAKE_FLAGS}
# -s : Suppresss makefile output (e.g. entering/leaving directories) # -s : Suppress makefile output (e.g. entering/leaving directories)
# --output-sync target : For parallel compilation ensure output for each target is synchronized (make version >= 4.0) # --output-sync target : For parallel compilation ensure output for each target is synchronized (make version >= 4.0)
MAKEFLAGS := -s MAKEFLAGS := -s

View File

@ -42,6 +42,6 @@ Version updates are made in the following scenario
- significant improvements on Quality-of-Results (QoR). - significant improvements on Quality-of-Results (QoR).
- significant changes on user interface. - significant changes on user interface.
- a techical feature is developed and validated by the community, which can impact the complete design flow. - a technical feature is developed and validated by the community, which can impact the complete design flow.

View File

@ -46,7 +46,7 @@ Once the ``openfpga.sh`` script is sourced, you can run any following commands d
.. option:: clear-task-run <task_name> .. option:: clear-task-run <task_name>
Clears all run diretories of the given task Clears all run directories of the given task
.. option:: run-modelsim <task_name> .. option:: run-modelsim <task_name>

View File

@ -132,7 +132,7 @@ goto-task () {
done done
} }
# Clears enviroment variables and fucntions # Clears environment variables and functions
unset-openfpga (){ unset-openfpga (){
unset -v OPENFPGA_PATH unset -v OPENFPGA_PATH
unset -f list-tasks run-task run-flow goto-task goto-root >/dev/null 2>&1 unset -f list-tasks run-task run-flow goto-task goto-root >/dev/null 2>&1