aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-11-14 10:14:40 +0100
committerLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-11-16 15:31:53 +0100
commita6cb714a3903aa8f965d533254cab8b25f8ccf6a (patch)
tree80e79be302fba3da481ec3889ac15cfcdb31548c
parentcd5f1d0e1a08fccab633c584afc8c611c7eeed71 (diff)
downloadsparse-a6cb714a3903aa8f965d533254cab8b25f8ccf6a.tar.gz
doc: add header for optimization related documentation
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
-rw-r--r--Documentation/api.rst1
-rw-r--r--optimize.c8
2 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/api.rst b/Documentation/api.rst
index 09ed0c4d..0cc83016 100644
--- a/Documentation/api.rst
+++ b/Documentation/api.rst
@@ -25,4 +25,5 @@ Typing
Optimization
~~~~~~~~~~~~
+.. c:autodoc:: optimize.c
.. c:autodoc:: simplify.c
diff --git a/optimize.c b/optimize.c
index bfab74c0..fd4ecb99 100644
--- a/optimize.c
+++ b/optimize.c
@@ -1,10 +1,12 @@
// SPDX-License-Identifier: MIT
//
-// optimize.c - main optimization loop
-//
// Copyright (C) 2004 Linus Torvalds
// Copyright (C) 2004 Christopher Li
+///
+// Optimization main loop
+// ----------------------
+
#include <assert.h>
#include "optimize.h"
#include "flowgraph.h"
@@ -45,6 +47,8 @@ static void clean_up_insns(struct entrypoint *ep)
} END_FOR_EACH_PTR(bb);
}
+///
+// optimization main loop
void optimize(struct entrypoint *ep)
{
if (fdump_ir & PASS_LINEARIZE)