hlsBs Reference Manual

Contents

• hlsBs – A HLS Development and Build System
  • Introduction
    • Quick-Start
    • How To Read
    • The ‘Not for Claude’ Section
    • Limitations
    • Disclaimer
  • Goals
    • Primary Goals
    • Secondary, less user-facing goals
  • Overview
    • Setup - Brief
    • Project File - Brief
    • Commands - Brief
  • Setup
  • The Commands
    • A Word of Caution on Command Line Parameters
  • Project File - Overview
    • Locating the Project File
    • Environment Variables
      • Usage
    • Structure
      • Environment Variables & Product Parameters
      • Conventions: What to Name the Project File & Where to Put It
  • Project File - Annotated Example
    • Product Directory Methods
      • get_project_root (project)
      • get_products_root (project)
      • get_build (project)
      • get_workspace (project)
      • get_cfg_root (project)
      • get_ip_root (project)
    • Product Definition Methods
      • get_products - An example
      • Convenience Declarations
      • IncludePaths
      • DefineValue
      • IncludeFile
      • Sources
      • Build
      • Fpga
      • CtbBuilds
      • CtbFpgas
      • Contributors
      • CfgTemplate
      • CmpTemplate
      • Components
      • Package.Ip
      • Package.Output
      • Package
      • Vivado
      • Product
  • IP Products
    • DCP Renaming
    • FPGA Family Augmentation
    • Annotated get_ip
  • Global Product Parameters
    • Vitis Version
    • Git
  • Advanced Usage
    • Additional Component Contributors
      • Product.CtbValues
      • Product.CtbFiles
    • Parameter Files
      • Usage
      • Suggestion
    • Deferred Environment Variable Translation
      • Suggestions
      • Usage
  • A Word of Caution on Environment Variables
  • GIT: To Commit or Not To Commit, That is the Question
    • Finally - Input/Feedback Wanted