DOC: Added a project converion document for CLI
authorJihoon Song <jihoon.song@samsung.com>
Fri, 31 Jul 2015 12:17:35 +0000 (21:17 +0900)
committergeunhui.lim <geunhui.lim@samsung.com>
Tue, 4 Aug 2015 09:05:06 +0000 (18:05 +0900)
Change-Id: I93d40176ff3b9a820dcf8216fab956e4aa0a3187
Signed-off-by: Jihoon Song <jihoon.song@samsung.com>
org.tizen.devtools/html/index.htm
org.tizen.devtools/html/native_tools/project_conversion_n.htm [new file with mode: 0644]

index e249a85..24e4900 100644 (file)
                <li><a href="native_tools/po_file_editor_n.htm">PO File Editor</a></li>
                <li><a href="native_tools/uibuilder_n.htm">UI Builder</a></li>
                <li><a href="native_tools/enventor_n.htm">Enventor</a></li>
-               <li><a href="native_tools/command_line_interface_n.htm">Command Line Interface</a></li>
+               <li><a href="native_tools/command_line_interface_n.htm">Command Line Interface</a>
+                   <ul>
+            <li><a href="native_tools/project_conversion_n.htm">Project Conversion</a></li>
+                   </ul>
+               </li>
                <li><a href="native_tools/call_stack_view_n.htm">Call Stack View</a></li>
                <li><a href="native_tools/da_overview_n.htm">Dynamic Analyzer</a>
                        <ul>
diff --git a/org.tizen.devtools/html/native_tools/project_conversion_n.htm b/org.tizen.devtools/html/native_tools/project_conversion_n.htm
new file mode 100644 (file)
index 0000000..0f61bec
--- /dev/null
@@ -0,0 +1,207 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+       <meta http-equiv="X-UA-Compatible" content="IE=9" />
+       <link rel="stylesheet" type="text/css" href="../css/styles.css" />
+       <link rel="stylesheet" type="text/css" href="../css/snippet.css" />
+       <script type="text/javascript" src="../scripts/snippet.js"></script>    
+       <script type="text/javascript" src="../scripts/jquery.util.js" charset="utf-8"></script>
+       <script type="text/javascript" src="../scripts/common.js" charset="utf-8"></script>
+       <script type="text/javascript" src="../scripts/core.js" charset="utf-8"></script>
+       <script type="text/javascript" src="../scripts/search.js" charset="utf-8"></script>
+
+       <title>Project Conversion for CLI</title>  
+</head>
+
+<body onload="prettyPrint()" style="overflow: auto;">
+
+<div id="toc-navigation">
+       <div id="profile">
+               <p><img alt="Mobile native" src="../images/mn_icon.png"/> <img alt="Wearable native" src="../images/wn_icon.png"/></p>
+       </div>
+</div> 
+
+<div id="container"><div id="contents"><div class="content">
+
+<h1>Project Conversion for CLI</h1>
+
+<p>The Tizen SDK provides a method for building an IDE-created project by CLI:</p>
+
+<ol>
+    <li>Select a Tizen native project in the Project Explorer View of the IDE.</li>
+    <li>Open the context menu by right-click, and select '<strong>Export to CLI Project</strong>'.</li>
+</ol>
+
+<p>When the export is completed, 'make' files in 'Build' folder and 'project_def.prop' file which has many build options, will be added to the converted CLI project.</p>
+
+<p>And then you can build a converted project by the following CLI command.</p>
+
+<pre class="prettyprint">
+  $ tizen build-native -–arch x86 –-compiler llvm –-configuration Debug -- /home/workspace/basic
+</pre>
+
+  <table border="1"> 
+     <caption>
+       Table: Properties in 'project_def.prop' file
+     </caption> 
+     <tbody> 
+      <tr> 
+       <th style="text-align:center;margin-left:auto;margin-right:auto;">Key</th> 
+       <th style="text-align:center;margin-left:auto;margin-right:auto;">Value</th> 
+      </tr> 
+      <tr> 
+       <td>APPNAME</td> 
+       <td>It is the app name. It must be written in <strong>lowercase</strong> letters.<br><br>ex) APPNAME = test</td> 
+      </tr> 
+         <tr> 
+       <td>type</td> 
+       <td>Select the application type in <strong>app</strong>, <strong>sharedLib</strong>, <strong>staticLib</strong><br><br>ex) type = app</td> 
+      </tr>
+         <tr> 
+       <td>profile</td> 
+       <td>Select the profile with version.<br><br>ex) profile = mobile-2.3</td>
+      </tr>
+         <tr> 
+       <td>USER_SRCS</td> 
+       <td>It is a list of '.c', '.cpp' source files in the current project.<br>It can be used with wildcard characters like '*'.<br>If more than two files, a separator is a white-space character.<br><br>ex) USER_SRCS = src/*.c</td>
+      </tr>
+         <tr> 
+       <td>USER_DEFS</td> 
+       <td>It is a list of user-defined C files added to the compilation process.<br>It must be used without <strong>-D</strong> characters for C compiler.<br><br>ex) USER_DEFS = ABC DEF</td>
+      </tr>
+         <tr> 
+       <td>USER_UNDEFS</td> 
+       <td>It is a list of user-defined C files excluded from the compilation process.<br>It must be used without <strong>-U</strong> characters for C compiler.</td>
+      </tr>
+         <tr> 
+       <td>USER_CPP_DEFS</td> 
+       <td>It is a list of user-defined C++ files added to the compilation process.<br>It must be used without <strong>-D</strong> characters for C++ compiler.</td>
+      </tr>
+         <tr> 
+       <td>USER_CPP_UNDEFS</td> 
+       <td>It is a list of user-defined C++ files excluded from the compilation process.<br>It must be used without <strong>-U</strong> characters for C++ compiler.</td>
+      </tr>
+      <tr> 
+       <td>USER_LIBS</td> 
+       <td>It is a list of the library paths added to the linking process.<br>It must be used without <strong>-l</strong> characters.</td>
+      </tr>
+      <tr> 
+       <td>USER_OBJS</td> 
+       <td>It is a path list of the '.o' files added to the linking process.</td>
+      </tr>
+      <tr> 
+       <td>USER_OBJS_ABS</td> 
+       <td>It is a absolute path list of the '.o' files added to the linking process.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_INC_DIRS</td> 
+       <td>It is a path list of references for C compiling.<br>It must be used without <strong>-I</strong> characters.<br><br>ex) USER_INC_DIRS = inc</td>
+      </tr>
+      <tr> 
+       <td>USER_INC_DIRS_ABS</td> 
+       <td>It is an absolute path list of references for C compiling.<br>It must be used without <strong>-I</strong> characters.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.<br><br>ex) USER_INC_DIRS_ABS = $(workspace_loc)/extlib/lib</td>
+      </tr>
+      <tr> 
+       <td>USER_INC_FILES</td> 
+       <td>It is a path list of '.h' files for C.<br>It must be used without <strong>-include</strong> characters.</td>
+      </tr>
+      <tr> 
+       <td>USER_INC_FILES_ABS</td> 
+       <td>It is an absolute path list of '.h' files for C.<br>It must be used without <strong>-include</strong> characters.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_CPP_INC_DIRS</td> 
+       <td>It is a path list of references for C++ compiling.<br>It must be used without <strong>-I</strong> characters.</td>
+      </tr>
+      <tr> 
+       <td>USER_CPP_INC_DIRS_ABS</td> 
+       <td>It is an absolute path list of references for C++ compiling.<br>It must be used without <strong>-I</strong> characters.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_CPP_INC_FILES</td> 
+       <td>It is a path list of '.h' files for C++.<br>It must be used without <strong>-include</strong> characters.</td>
+      </tr>
+      <tr> 
+       <td>USER_CPP_INC_FILES_ABS</td> 
+       <td>It is an absolute path list of '.h' files for C++.<br>It must be used without <strong>-include</strong> characters.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_LIB_DIRS</td> 
+       <td>It is a path list of references for the library linking.<br>It must be used without <strong>-L</strong> characters.</td>
+      </tr>
+      <tr> 
+       <td>USER_LIB_DIRS_ABS</td> 
+       <td>It is an absolute path list of references for the library linking.<br>It must be used without <strong>-L</strong> characters.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS</td> 
+       <td>It is a path list of '.edc' files.<br>It can be used with wildcard characters like '*'.<br>If more than two files, a separator is a white-space character.<br><br>ex) USER_EDCS = res/edje/*.edc</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_IMAGE_DIRS</td> 
+       <td>It is a path list of EDC references for compiling like <strong>'-id'</strong> option of the IDE.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_IMAGE_DIRS_ABS</td> 
+       <td>It is an absolute path list of EDC references for compiling like <strong>'-id'</strong> option of the IDE.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_SOUND_DIRS</td> 
+       <td>It is a path list of EDC references for compiling like <strong>'-sd'</strong> option of the IDE.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_SOUND_DIRS_ABS</td> 
+       <td>It is an absolute path list of EDC references for compiling like <strong>'-sd'</strong> option of the IDE.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_FONT_DIRS</td> 
+       <td>It is a path list of EDC references for compiling like <strong>'-fd'</strong> option of the IDE.</td>
+      </tr>
+      <tr> 
+       <td>USER_EDCS_FONT_DIRS_ABS</td> 
+       <td>It is an absolute path list of EDC references for compiling like <strong>'-fd'</strong> option of the IDE.<br>It is recommended to use <strong>$(workspace_loc)</strong> for IDE compatibility.</td>
+      </tr>
+      <tr> 
+       <td>USER_POS</td> 
+       <td>It is a path list of '.po' files.<br>It can be used with wildcard characters like '*'.<br>If more than two files, a separator is a white-space character.<br><br>ex) USER_POS = res/po/*.po</td>
+      </tr>
+     </tbody> 
+    </table>
+
+<table class="note">
+    <tbody>
+        <tr>
+            <th class="note">Note</th>
+        </tr>
+        <tr>
+            <td class="note">The converted CLI project cannot be reconverted to the IDE-based project.</td>
+        </tr>
+    </tbody>
+</table>
+
+    
+<script type="text/javascript" src="../scripts/jquery.zclip.min.js"></script>
+<script type="text/javascript" src="../scripts/showhide.js"></script>
+</div></div></div>
+
+<a class="top sms" href="#"><img src="../images/btn_top.gif" alt="Go to top" /></a>
+
+<div id="footer">
+<p class="footer">Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>.<br/>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.</p>
+</div>
+
+<script type="text/javascript">
+var _gaq = _gaq || [];
+_gaq.push(['_setAccount', 'UA-25976949-1']);
+_gaq.push(['_trackPageview']);
+(function() {
+var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
+</script>
+
+</body>
+</html>
+