Skip to content

Commit c429387

Browse files
committed
Getting Started documentation update.
* Put Core Build and Managed Build items in separate topics. * Added two images to Creating a CMake project. * Added new pages about creating a CBS Makefile project, using existing code, and the launch bar. * Renamed "Creating a simple application" to "Creating a Managed Build System Makefile project" and replaced two images. * Removed "Creating a Makefile project", because it was duplicate information. Fixes #992
1 parent 9e04dc5 commit c429387

20 files changed

+312
-194
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
////
2+
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation
3+
This program and the accompanying materials
4+
are made available under the terms of the Eclipse Public License 2.0
5+
which accompanies this distribution, and is available at
6+
https://www.eclipse.org/legal/epl-2.0/
7+
8+
SPDX-License-Identifier: EPL-2.0
9+
////
10+
11+
// pull in shared headers, footers, etc
12+
:docinfo: shared
13+
14+
// support image rendering and table of contents within GitHub
15+
ifdef::env-github[]
16+
:imagesdir: ../../images
17+
:toc:
18+
:toc-placement!:
19+
endif::[]
20+
21+
// enable support for button, menu and keyboard macros
22+
:experimental:
23+
24+
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency,
25+
// this is checked by the build in do_generate_asciidoc.sh, which also ensures
26+
// that the checked in html is up to date.
27+
// do_generate_asciidoc.sh can also be used to apply this header to all the
28+
// adoc files.
29+
// ENDOFHEADER
30+
31+
== Launch Bar
32+
33+
CBS projects rely on the *LaunchBar*. Make sure the launch bar plugin
34+
is installed and enabled. In the global preferences the launch bar can
35+
be enabled or disabled.
36+
37+
image:launchbar_preferences.png[Launch Bar preferences]
38+
39+
The launch bar exists out of several components:
40+
41+
image:launchbar.png[Launch Bar]
42+
43+
. Build button, to launch a build.
44+
. Run button, to launch a run. This button will change to a Debug
45+
button in Debug mode.
46+
. Stop button, to stop a Run or Debug session.
47+
. Launch mode selector. To change between Run and Debug mode.
48+
. Launch configuration selector.
49+
. Edit launch configuration. To change the launch configuration
50+
properties.
51+
. Target selector. Not always visible.
52+
. Edit target.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
////
2+
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation
3+
This program and the accompanying materials
4+
are made available under the terms of the Eclipse Public License 2.0
5+
which accompanies this distribution, and is available at
6+
https://www.eclipse.org/legal/epl-2.0/
7+
8+
SPDX-License-Identifier: EPL-2.0
9+
////
10+
11+
// pull in shared headers, footers, etc
12+
:docinfo: shared
13+
14+
// support image rendering and table of contents within GitHub
15+
ifdef::env-github[]
16+
:imagesdir: ../../images
17+
:toc:
18+
:toc-placement!:
19+
endif::[]
20+
21+
// enable support for button, menu and keyboard macros
22+
:experimental:
23+
24+
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency,
25+
// this is checked by the build in do_generate_asciidoc.sh, which also ensures
26+
// that the checked in html is up to date.
27+
// do_generate_asciidoc.sh can also be used to apply this header to all the
28+
// adoc files.
29+
// ENDOFHEADER
30+
31+
== Using existing code
32+
33+
This tutorial describes how to use existing code for Core Build System
34+
projects.
35+
36+
Using existing code is done by creating a new **empty** project on top of the
37+
existing code.
38+
39+
=== Using an existing CMake project
40+
41+
To create an empty CMake project select the template *Empty or Existing CMake
42+
Project* in the *New C/{cpp} Project* wizard.
43+
44+
image:cbs_empty_cmake_project.png[Empty or Existing CMake Project]
45+
46+
Then in the *New CMake Project* wizard deselect *Use default location*
47+
and set the location of the existing code.
48+
49+
image:cbs_existing_code_cmake.png[Existing code CMake]
50+
51+
More information about creating a CMake project is described in
52+
xref:new_cmake_proj.adoc[Creating a CMake project]
53+
54+
=== Using an existing Makefile project
55+
56+
Create a Makefile project as described in
57+
xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project]
58+
with the following changes:
59+
60+
In the *New Makefile Project* wizard deselect *Use default location*
61+
and set the location of the existing code, and deselect *Create Hello
62+
World Source and Makefile example*.
63+
64+
image:cbs_existing_code_makefile.png[Existing code Makefile]
65+
66+
icon:arrow-circle-right[] xref:cbs_launchbar.adoc[Next: Launch Bar]

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_w_basic.adoc

+7-15
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,13 @@ endif::[]
2828
// adoc files.
2929
// ENDOFHEADER
3030

31-
== Tutorial: Creating a simple application
31+
== Tutorial: Creating a Managed Build System Makefile project
3232

3333
In this tutorial, you will use the CDT to create a simple 'Hello World'
3434
application. This tutorial describes the process of creating a new {cpp}
3535
project where the build is automatically managed by the CDT, and running
3636
the program.
3737

38-
*NOTE*: In earlier versions of the CDT, there were two separate project
39-
types: Managed make (automatically generated a makefile) and Standard
40-
make (required the user's makefile to build). Now with CDT, you just
41-
select a project type, and that determines what build system to use.
42-
4338
To create a simple "Hello World" application using CDT, perform the
4439
following general steps:
4540

@@ -57,10 +52,13 @@ image:cdt_w_basic02.png[Select File > New > Project menu
5752
option,width=591,height=183]
5853
+
5954
. Select the type of project to create. For this tutorial, expand the
60-
*{cpp}* folder and select *{cpp} Project* and click *Next*.
55+
*C/{cpp}* folder and select *C/{cpp} Project* and click *Next*.
56+
+
57+
image:cdt_w_basic03a.png[Select project type]
58+
+
59+
. Select *{cpp} Managed Build* and click *Next*.
6160
+
62-
image:cdt_w_basic03a.png[Select project
63-
type,width=525,height=500]
61+
image:cdt_w_basic03b.png[Select {cpp} Managed Build]
6462
+
6563
. The *{cpp} Project* wizard opens.
6664
+
@@ -139,12 +137,6 @@ populated with objects created from your code.
139137
image:cdt_w_basic13.png[C Editor with Outline
140138
view,width=731,height=333]
141139
+
142-
*NOTE:* You can specify a different editor, and add or modify existing
143-
code templates in *Window > Preferences*.
144-
+
145-
*OPTIONAL*: You can type additional code in this file, and then save the
146-
changes by clicking File > Save, or pressing *CTRL+S*.
147-
+
148140
Next, you will need to build your project before you can run it.
149141
+
150142
. Build your project by pressing *CTRL+B*, or select the project in the

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_w_newcpp.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ xref:cdt_w_newmake.adoc[image:ngnext.gif[Next
8888
icon,width=16,height=16]] *xref:cdt_w_newmake.adoc[Next: Creating your
8989
makefile]*
9090

91-
xref:cdt_w_newproj.adoc[image:ngback.gif[Back
92-
icon,width=16,height=16]] *xref:cdt_w_newproj.adoc[Back: Creating your
93-
project]*
91+
xref:cdt_w_import.adoc[image:ngback.gif[Back
92+
icon,width=16,height=16]] *xref:cdt_w_import.adoc[Back: Importing an
93+
existing project]*
9494

9595
image:ngconcepts.gif[Related concepts,width=143,height=21]
9696

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_w_newproj.adoc

-165
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
////
2+
Copyright (c) 2000, 2025 Contributors to the Eclipse Foundation
3+
This program and the accompanying materials
4+
are made available under the terms of the Eclipse Public License 2.0
5+
which accompanies this distribution, and is available at
6+
https://www.eclipse.org/legal/epl-2.0/
7+
8+
SPDX-License-Identifier: EPL-2.0
9+
////
10+
11+
// pull in shared headers, footers, etc
12+
:docinfo: shared
13+
14+
// support image rendering and table of contents within GitHub
15+
ifdef::env-github[]
16+
:imagesdir: ../../images
17+
:toc:
18+
:toc-placement!:
19+
endif::[]
20+
21+
// enable support for button, menu and keyboard macros
22+
:experimental:
23+
24+
// Until ENDOFHEADER the content must match adoc-headers.txt for consistency,
25+
// this is checked by the build in do_generate_asciidoc.sh, which also ensures
26+
// that the checked in html is up to date.
27+
// do_generate_asciidoc.sh can also be used to apply this header to all the
28+
// adoc files.
29+
// ENDOFHEADER
30+
31+
= Core Build System contents
32+
33+
xref:core_build_system.adoc[Core Build System]
34+
35+
xref:new_cmake_proj.adoc[Creating a CMake project]
36+
37+
xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project]
38+
39+
xref:cbs_using_existing_code.adoc[Using existing code]
40+
41+
xref:cbs_launchbar.adoc[Launch Bar]

0 commit comments

Comments
 (0)