From f323576fae87892a48ea78a9ac56f95120e60ce4 Mon Sep 17 00:00:00 2001 From: JanLJL Date: Thu, 5 Mar 2020 15:28:30 +0100 Subject: [PATCH] renamed doc to docs and more documentation --- README.rst | 4 ++-- ...h_Detection_For_In-Core_Performance_Analysis.pdf | Bin ..._Framework_Predicting_Instruction_Throughput.pdf | Bin {doc => docs}/OSACA_Presentation_final.pdf | Bin {doc => docs}/osaca-logo.pdf | Bin {doc => docs}/osaca-logo.png | Bin {doc => docs}/osaca-workflow.png | Bin osaca/frontend.py | 4 +++- osaca/osaca.py | 4 ++++ 9 files changed, 9 insertions(+), 3 deletions(-) rename {doc => docs}/Cross-Architecture_Autimatic_Critical_Path_Detection_For_In-Core_Performance_Analysis.pdf (100%) rename {doc => docs}/Design_and_Implementation_For_a_Framework_Predicting_Instruction_Throughput.pdf (100%) mode change 100755 => 100644 rename {doc => docs}/OSACA_Presentation_final.pdf (100%) rename {doc => docs}/osaca-logo.pdf (100%) rename {doc => docs}/osaca-logo.png (100%) rename {doc => docs}/osaca-workflow.png (100%) diff --git a/README.rst b/README.rst index 861d7af..8fabee0 100644 --- a/README.rst +++ b/README.rst @@ -170,7 +170,7 @@ AArch64 markers ^^^^^^^^^^^^^^^ **Byte markers** -.. code-block:: asm +.. code-block:: arm mov x1, #111 // OSACA START .byte 213,3,32,31 // OSACA START @@ -182,7 +182,7 @@ AArch64 markers **Comment line markers** -.. code-block:: asm +.. code-block:: arm // OSACA-BEGIN .loop: diff --git a/doc/Cross-Architecture_Autimatic_Critical_Path_Detection_For_In-Core_Performance_Analysis.pdf b/docs/Cross-Architecture_Autimatic_Critical_Path_Detection_For_In-Core_Performance_Analysis.pdf similarity index 100% rename from doc/Cross-Architecture_Autimatic_Critical_Path_Detection_For_In-Core_Performance_Analysis.pdf rename to docs/Cross-Architecture_Autimatic_Critical_Path_Detection_For_In-Core_Performance_Analysis.pdf diff --git a/doc/Design_and_Implementation_For_a_Framework_Predicting_Instruction_Throughput.pdf b/docs/Design_and_Implementation_For_a_Framework_Predicting_Instruction_Throughput.pdf old mode 100755 new mode 100644 similarity index 100% rename from doc/Design_and_Implementation_For_a_Framework_Predicting_Instruction_Throughput.pdf rename to docs/Design_and_Implementation_For_a_Framework_Predicting_Instruction_Throughput.pdf diff --git a/doc/OSACA_Presentation_final.pdf b/docs/OSACA_Presentation_final.pdf similarity index 100% rename from doc/OSACA_Presentation_final.pdf rename to docs/OSACA_Presentation_final.pdf diff --git a/doc/osaca-logo.pdf b/docs/osaca-logo.pdf similarity index 100% rename from doc/osaca-logo.pdf rename to docs/osaca-logo.pdf diff --git a/doc/osaca-logo.png b/docs/osaca-logo.png similarity index 100% rename from doc/osaca-logo.png rename to docs/osaca-logo.png diff --git a/doc/osaca-workflow.png b/docs/osaca-workflow.png similarity index 100% rename from doc/osaca-workflow.png rename to docs/osaca-workflow.png diff --git a/osaca/frontend.py b/osaca/frontend.py index 7934ca8..7e0e991 100755 --- a/osaca/frontend.py +++ b/osaca/frontend.py @@ -37,7 +37,8 @@ class Frontend(object): """ Checks if instruction form is a comment-only line. - :param instruction_form: instruction form as dict + :param instruction_form: instruction form to check + :type instruction_form: `dict` :returns: `True` if comment line, `False` otherwise """ return instruction_form['comment'] is not None and instruction_form['instruction'] is None @@ -272,6 +273,7 @@ class Frontend(object): #################### def _missing_instruction_error(self, amount): + """Returns the warning for if any instruction form in the analysis is missing.""" s = ( '------------------ WARNING: The performance data for {} instructions is missing.' '------------------\n' diff --git a/osaca/osaca.py b/osaca/osaca.py index 8d63aa9..5d5dd62 100755 --- a/osaca/osaca.py +++ b/osaca/osaca.py @@ -51,6 +51,8 @@ def create_parser(parser=None): """ Return argparse parser. + :param parser: Existing parser object to add the arguments, defaults to `None` + :type parser: :class:`~Argparse.ArgumentParser` :returns: The newly created :class:`~Argparse.ArgumentParser` object. """ # Create parser @@ -156,6 +158,8 @@ def import_data(benchmark_type, arch, filepath, output_file=sys.stdout): :type arch: str :param filepath: filepath of the output file" :type filepath: str + :param output_file: output stream specifying where to write output, defaults to :class:`sys.stdout` + :type output_file: stream """ if benchmark_type.lower() == 'ibench': import_benchmark_output(arch, 'ibench', filepath, output=output_file)