Skip to content

Update Getting Started page. #1229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2025
Merged

Update Getting Started page. #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_restart.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_find-install.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_install_cdt_site.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_install_new_sites.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_install_sites.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_jar_verification.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_license_agreement.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_location.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/org.eclipse.cdt.doc.user/images/cdt_update_search_results.png
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/getting_started/cbs_launchbar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ endif::[]
// adoc files.
// ENDOFHEADER

== Launch Bar
== Using the Launch Bar

Core Build System (CBS) projects rely on the *Launch Bar*. Make sure
the _LaunchBar UI_ feature is installed and enabled. In the global
Expand Down
2 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/getting_started/cbs_using_existing_code.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ World Source and Makefile example*.

image:cbs_existing_code_makefile.png[Existing code Makefile]

icon:arrow-circle-right[] xref:cbs_launchbar.adoc[Next: Launch Bar]
icon:arrow-circle-right[] xref:cbs_launchbar.adoc[Next: Using the Launch Bar]
29 changes: 18 additions & 11 deletions doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to adjust these bullet points to all use the same part of speech. However, this might imply changes to the title of the pages to which they point for consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,24 @@ endif::[]
The following tutorials guide you through the process of using the C/{cpp}
Development Toolkit (CDT) to:

* xref:cdt_w_prepare_workbench.adoc[Prepare the Workbench]
* xref:cdt_w_basic.adoc[Create a simple application]
* xref:new_cmake_proj.adoc[Creating a CMake project]
* xref:cdt_w_basic.adoc[Create a Managed Build System Makefile project]
* xref:cdt_w_import.adoc[Import an existing project]
* xref:cdt_w_newcpp.adoc[Create a {cpp} file]
* xref:cdt_w_newmake.adoc[Create a makefile]
* xref:cdt_w_build.adoc[Build a project]
* xref:cdt_w_debug.adoc[Debug a project]
* xref:cdt_w_existing_code.adoc[Import C/{cpp} source into Eclipse]
* xref:cdt_w_install_cdt.adoc[Install/update the CDT]
* xref:cdt_w_prepare_workbench.adoc[Preparing the Workbench]
* xref:index_cbs.adoc[Core Build System]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* xref:index_cbs.adoc[Core Build System]
* xref:index_cbs.adoc[Using the Core Build System]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

** xref:core_build_system.adoc[Using the Core Build System]
** xref:new_cmake_proj.adoc[Creating a CMake project]
** xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project]
** xref:cbs_using_existing_code.adoc[Using existing code]
** xref:cbs_launchbar.adoc[Using the Launch Bar]
** xref:cbs_build_project.adoc[Building a project]
** xref:cbs_run_project.adoc[Running a project]
** xref:cbs_debug_project.adoc[Debugging a project]
* xref:index_mbs.adoc[Legacy Managed Build System]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* xref:index_mbs.adoc[Legacy Managed Build System]
* xref:index_mbs.adoc[Using the legacy Managed Build System]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one I did not do, because it's an index page. Like index_cbs.adoc.
I did remove the " contents" suffix in the titles of index_[cm]bs.adoc.

** xref:cdt_w_basic.adoc[Tutorial: Creating a Managed Build System Makefile project]
** xref:cdt_w_import.adoc[Tutorial: Importing an existing project]
** xref:cdt_w_newcpp.adoc[Creating your {cpp} file]
** xref:cdt_w_newmake.adoc[Creating a makefile]
** xref:cdt_w_build.adoc[Building a project]
** xref:cdt_w_debug.adoc[Debugging a project]
** xref:cdt_w_existing_code.adoc[Importing your C/{cpp} source files into Eclipse]

image:ngref.gif[Related reference]

Expand Down
112 changes: 0 additions & 112 deletions doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_w_install_cdt.adoc
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/getting_started/core_build_system.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ endif::[]
// adoc files.
// ENDOFHEADER

= Core Build System
= Using the Core Build System

The Core Build System is the successor of the legacy Managed Build
System.
Expand Down
6 changes: 3 additions & 3 deletions doc/org.eclipse.cdt.doc.user/src/getting_started/index_cbs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ endif::[]
// adoc files.
// ENDOFHEADER

= Core Build System contents
= Core Build System

xref:core_build_system.adoc[Core Build System]
xref:core_build_system.adoc[Using the Core Build System]

xref:new_cmake_proj.adoc[Creating a CMake project]

xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project]

xref:cbs_using_existing_code.adoc[Using existing code]

xref:cbs_launchbar.adoc[Launch Bar]
xref:cbs_launchbar.adoc[Using the Launch Bar]

xref:cbs_build_project.adoc[Building a project]

Expand Down
2 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/getting_started/index_mbs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ endif::[]
// adoc files.
// ENDOFHEADER

= Legacy Managed Build System contents
= Legacy Managed Build System

xref:cdt_w_basic.adoc[Tutorial: Creating a Managed Build System Makefile project]

Expand Down
2 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/getting_started/new_cmake_proj.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ Your new project displays in the Project Explorer view.
Your project may be empty because you have not yet created files for your project.
You can now start writing the code for your application or importing code from elsewhere.

icon:arrow-circle-right[] xref:new_cbs_makefile_proj.adoc[Next: Creating a Makefile project]
icon:arrow-circle-right[] xref:new_cbs_makefile_proj.adoc[Next: Creating a Core Build System Makefile project]
1 change: 0 additions & 1 deletion doc/org.eclipse.cdt.doc.user/topics_Getting_Started.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,4 @@
<topic label="Debugging projects" href="getting_started/cdt_w_debug.htm"/>
<topic label="Importing C/C++ source files into Eclipse" href="getting_started/cdt_w_existing_code.htm"/>
</topic>
<!--topic label="Updating the CDT" href="getting_started/cdt_w_install_cdt.htm"/-->
</toc>
Loading