tiflow icon indicating copy to clipboard operation
tiflow copied to clipboard

Add help docs for makefile

Open hi-rustin opened this issue 1 year ago • 1 comments

Is your feature request related to a problem?

For now, we have a bunch of make commands but no docs. It isn't easy to find the available commands.

Describe the feature you'd like

Adapt from https://www.thapaliya.com/en/writings/well-documented-makefiles/ and add help docs for each command.

Describe alternatives you've considered

No response

Teachability, Documentation, Adoption, Migration Strategy

No response

hi-rustin avatar Jul 27 '22 07:07 hi-rustin

Introduced in https://github.com/pingcap/tiflow/pull/6568

We need to add help for other targets.

hi-rustin avatar Aug 03 '22 03:08 hi-rustin