Commit b0dfd6e3 authored by Davide Cieri's avatar Davide Cieri
Browse files

warning

parent fa54187e

docs/01-Getting-Started/01-howto-existingProjects.md

+3 −0
Original line number Diff line number Diff line 
<!-- # Getting Started -->



# Work with an existing Hog-handled repository

```{warning} Outdated Documentation!

    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).

```



This section is intended for a developer that starts working with an existing HDL project that is managed with Hog.

docs/01-Getting-Started/02-howto-convert-project.md

+3 −0
Original line number Diff line number Diff line 
# How to convert an existing project to Hog

```{warning} Outdated Documentation!

    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).

```



Converting an existing project to Hog means: copying the source files into a git repository, adding Hog as a submodule, creating the Hog list files (text files containing the names of your source files), and writing a `hog.conf` file, storing the project's properties.

docs/01-Getting-Started/03-howto-update-hog.md

+3 −0
Original line number Diff line number Diff line 
# Update Hog to a newer release

```{warning} Outdated Documentation!

    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).

```



This guide will help you to update Hog to the version you want. We assume you already have a repository handled with Hog that is hosted on CERN GitLab.

docs/01-Getting-Started/04-Example-Project.md

+3 −0
Original line number Diff line number Diff line 
# Example GitLab Project

```{warning} Outdated Documentation!

    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).

```



An example Hog-handled repository is available at [https://gitlab.com/hog-cern/hog-examples](https://gitlab.com/hog-cern/hog-examples).

docs/01-Getting-Started/05-FAQ.md

+3 −0
Original line number Diff line number Diff line 
# Frequently Asked Questions (FAQs)

```{warning} Outdated Documentation!

    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).

```



### Does Hog support HLS in Vivado?

Our idea is to store in the HDL repository only the files required to build the project. Therefore, for HLS, we suggest keeping the C++ code in another repo, and then commit to the HDL repository the resulting user IPs and the `.xci` file. For more details on how to work with user IPs in Vivado, have a look at the [User IP Chapter](../02-User-Manual/01-Hog-local/12-User-IPs.md).