4. Developer Tools

This chapter describes the development ecosystem generally used to create new modules.

• 4.1. Working with Git as a user
  • 4.1.1. ns-3’s Git workflow in a nutshell
  • 4.1.2. Setup of a personal repository
  • 4.1.3. Add the official ns-3 repository as remote upstream
  • 4.1.4. Add your forked repository as remote
  • 4.1.5. Keep in sync your repository with latest ns-3-dev updates
  • 4.1.6. Start a new branch to do some work
  • 4.1.7. Edit and commit the modifications
  • 4.1.8. Rebase your branch on top of master
  • 4.1.9. Pushing your changes to origin
  • 4.1.10. Submit work for review
  • 4.1.11. Porting patches from mercurial repositories to Git
• 4.2. Working with Git as a maintainer
  • 4.2.1. Pushing your own work
  • 4.2.2. Review and merge someone else’s work
  • 4.2.3. Making a release
• 4.3. Working with CMake
  • 4.3.1. Configuring the project
  • 4.3.2. Manually refresh the CMake cache
  • 4.3.3. Building the project
  • 4.3.4. Adding a new module
  • 4.3.5. Migrating a Waf module to CMake
  • 4.3.6. Running programs
  • 4.3.7. Modifying files
  • 4.3.8. CCache and Precompiled Headers
• 4.4. Logging
  • 4.4.1. Overview
  • 4.4.2. Enabling Output
  • 4.4.3. NS_LOG Syntax
  • 4.4.4. How to add logging to your code
  • 4.4.5. Controlling timestamp precision
  • 4.4.6. Asserts
• 4.5. Tests
  • 4.5.1. Overview
  • 4.5.2. Background
  • 4.5.3. Testing framework
  • 4.5.4. How to write tests
• 4.6. Creating a new ns-3 model
  • 4.6.1. Design Approach
  • 4.6.2. Scaffolding
  • 4.6.3. Initial Implementation
  • 4.6.4. Adding a Sample Script
  • 4.6.5. Add a Subclass
  • 4.6.6. Build Core Functions and Unit Tests
• 4.7. Adding a New Module to ns-3
  • 4.7.1. Step 0 - Module Layout
  • 4.7.2. Step 1 - Create a Module Skeleton
  • 4.7.3. Step 3 - Declare Source Files
  • 4.7.4. Step 4 - Declare Public Header Files
  • 4.7.5. Step 5 - Declare Tests
  • 4.7.6. Step 6 - Declare Examples
  • 4.7.7. Step 7 - Examples Run as Tests
  • 4.7.8. Step 8 - Configure and Build
  • 4.7.9. Step 9 - Python Bindings
• 4.8. Creating Documentation
  • 4.8.1. Documenting with Sphinx
  • 4.8.2. Documenting with Doxygen
• 4.9. Profiling
  • 4.9.1. Memory Profilers
  • 4.9.2. Performance Profilers
  • 4.9.3. System calls profilers
  • 4.9.4. Compilation Profilers
  • 4.9.5. CMake Profiler
• 4.10. Working with gitlab-ci-local
• 4.11. Working with Docker
  • 4.11.1. Docker containers
  • 4.11.2. Podman containers