Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
PHILO-HE committed Aug 20, 2024
1 parent 23ceb9a commit ca0181c
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/developers/UsingGperftoolsInCH.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
layout: page
title: Developer Overview
nav_order: 11
has_children: true
permalink: /developer-overview/
---
We need using gpertools to find the memory or CPU issue. That's what this document is about.

## Install gperftools
Expand Down
7 changes: 7 additions & 0 deletions docs/developers/UsingJemallocWithCH.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
layout: page
title: Developer Overview
nav_order: 12
has_children: true
permalink: /developer-overview/
---
We need using jemalloc to find the memory issue. That's what this document is about.

## Change code of jemalloc
Expand Down
7 changes: 7 additions & 0 deletions docs/developers/VeloxUDF.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
layout: page
title: Developer Overview
nav_order: 13
has_children: true
permalink: /developer-overview/
---
# Velox User-Defined Functions (UDF) and User-Defined Aggregate Functions (UDAF)

## Introduction
Expand Down
22 changes: 22 additions & 0 deletions docs/developers/velox_backend_CI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: page
title: CPP Code Style
nav_order: 14
parent: Developer Overview
---
# Velox Backend CI

GHA workflows are defined under `.github/workflows/`.

## Docker Build
We have a weekly job to build a docker based on Dockerfile.gha for CI verification, defined in docker_image.yml.

## Vcpkg Caching
Gluten main branch is pulled down during docker build. And vcpkg will cache binary data of all dependencies defined under dev/vcpkg.
These binary data is cached into `/var/cache/vcpkg` and CI job can re-use them in new build. By setting `VCPKG_BINARY_SOURCES=clear` in env., reusing cache can be disabled.

## Arrow Libs Pre-installation
Arrow libs are also pre-installed in docker, assuming they are not actively changed and not necessarily to be re-built every time.

## Updating Docker
Two Github secrets `DOCKERHUB_USER` & `DOCKERHUB_TOKEN` can be used to push docker to docker hub: https://hub.docker.com/r/apache/gluten/tags.

0 comments on commit ca0181c

Please sign in to comment.