Difference between revisions of "Configuring C Projects"

From AtlasWiki
Jump to: navigation, search
Line 20: Line 20:
  
 
<br>
 
<br>
−
<u>Setting up C projects for Atlas</u>
+
<u>Advanced Set up for C projects</u>
 
<br>
 
<br>
  
−
#Enable the Atlas Error Parser:
+
For a typical C project, no further setup is necessary. However, large projects like the Linux kernel have a complicated build system that Atlas must understand in order to map the code correctly. To do this Atlas will analyze the build commands used to build the project. The steps below detail the changes necessary to map only the files built by the make file.
−
#*Right-click on the project in the package explorer and select '''Properties'''.
+
 
−
#*Under '''Atlas C/C++ Build''', click the button '''Enable Atlas Error Parser''' (if it is not grayed out already) and click '''OK'''.
+
 
#Add the compiler build command:
 
#Add the compiler build command:
−
#*Right-click on the project in the package explorer and select '''Properties'''.
+
#* Right-click on the project in the package explorer and select '''Properties'''.
−
#* Under '''Atlas C/C++ Build''', add the compiler command to the '''Build Commands'''. These are the commands that will be parsed from the output of the project's makefile.
+
#* Under '''Atlas C/C++ Build''', add the name of the compiler used by the project to the '''Build Commands'''. Atlas will look for commands sent to these compilers when parsing the output of the project's makefile.
 +
#* Click '''OK'''.
 +
# Use information from build commands
 +
#* Right-click on the project in the package explorer and select '''Properties'''.
 +
#* Select '''Map only files in current build''' under '''Source files to map'''.
 +
#* Select '''Use discovered configuration for files in the current build''' under '''File configuration'''.
 
#* Click '''OK'''.
 
#* Click '''OK'''.
−
#Choose the project to be indexed:
 
−
#*Open the '''Atlas''' menu and select '''Manage Project Settings'''.
 
−
#*Select the project to be indexed, click the '''Add''' button, and click '''OK'''.
 
−
#*An index can be run by selecting '''Index Workspace''' under the '''Atlas''' menu.
 
  
 
<br>
 
<br>
−
<u>Troubleshooting</u>:  If Atlas is unable to properly index the project, try the following fixes:
+
<u>Troubleshooting</u>:  If Atlas is unable to properly map the project, try the following fixes:
 
<br>
 
<br>
  
Line 50: Line 50:
 
#*Add the flag “--print-directory”.
 
#*Add the flag “--print-directory”.
 
#*Clean and build the project.
 
#*Clean and build the project.
 +
 +
<br>
 +
For versions of Atlas before Atlas 3.0, see the set up instructions at [[Configuring C Projects for Atlas 2.0]].
  
 
<br>
 
<br>
 
If you experience difficulty in setting up Atlas, please contact [mailto:[email protected] [email protected]] for assistance.
 
If you experience difficulty in setting up Atlas, please contact [mailto:[email protected] [email protected]] for assistance.

Revision as of 10:56, 6 June 2016

Atlas for C is still in beta and may require some setup. Please refer to the following steps for configuring C projects properly. In the future, this process will be streamlined.


Importing C projects in Eclipse

  1. Import, if the project has a Makefile:
    • Right-click in the package explorer.
    • Select Import.
    • In the popup dialogue, expand C/C++, select Existing Code as Makefile Project, and click Next.
    • Enter a project name and indicate the directory to import.
    • Click Finish.
  2. Import, if the project does NOT have a Makefile:
    • Right-click in the package explorer.
    • Select New > Project…
    • In the popup dialogue, select General > Project and click Next.
    • Enter a project name and click Finish.
    • Right-click on the project and select Import.
    • Enter the parent directory, select files to import, and click Finish.


Advanced Set up for C projects

For a typical C project, no further setup is necessary. However, large projects like the Linux kernel have a complicated build system that Atlas must understand in order to map the code correctly. To do this Atlas will analyze the build commands used to build the project. The steps below detail the changes necessary to map only the files built by the make file.

  1. Add the compiler build command:
    • Right-click on the project in the package explorer and select Properties.
    • Under Atlas C/C++ Build, add the name of the compiler used by the project to the Build Commands. Atlas will look for commands sent to these compilers when parsing the output of the project's makefile.
    • Click OK.
  2. Use information from build commands
    • Right-click on the project in the package explorer and select Properties.
    • Select Map only files in current build under Source files to map.
    • Select Use discovered configuration for files in the current build under File configuration.
    • Click OK.


Troubleshooting: If Atlas is unable to properly map the project, try the following fixes:

  1. Clean and build the project and make sure the build output is being correctly parsed:
    • Right-click on the project in the package explorer and select Properties.
    • Look under Atlas C/C++ Build > Build Configuration File.
    • If the Open button under Build Configuration File is grayed out, or if it says zero files were found, then Atlas was unable to detect the build configuration. Select C/C++ Build and uncheck “Use default build command”.
    • Adjust the command to make the output verbose. Necessary flags may vary; common options include “V=1” or “VERBOSE=1”.
    • Clean and build the project and check that Build Configuration File is nonzero.
  2. If Atlas’ index is still empty, it may be that the Makefile is improperly reporting changing directories.
    • Right-click on the project in the package explorer and select Properties.
    • Select C/C++ Build and uncheck “Use default build command”.
    • Add the flag “--print-directory”.
    • Clean and build the project.


For versions of Atlas before Atlas 3.0, see the set up instructions at Configuring C Projects for Atlas 2.0.


If you experience difficulty in setting up Atlas, please contact [email protected] for assistance.

Retrieved from "https://ensoftatlas.com/index.php?title=Configuring_C_Projects&oldid=2367"