From 3d45135a626a40b1cd6495454c7d58297f056ebf Mon Sep 17 00:00:00 2001 From: Christian Guinard <28689358+christiangnrd@users.noreply.github.com> Date: Tue, 10 Dec 2024 17:37:15 -0400 Subject: [PATCH] Mention wrapping in contributing docs --- docs/src/faq/contributing.md | 6 +++++- res/wrap/README.md | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/src/faq/contributing.md b/docs/src/faq/contributing.md index 2f17b21a9..480b4b6f2 100644 --- a/docs/src/faq/contributing.md +++ b/docs/src/faq/contributing.md @@ -38,6 +38,10 @@ skip the first two steps. 2. Create high-level Julia structures and functionality 3. Create tests for added functionality +`struct`s and `enums` for Objective-C interfaces are automatically generated (see res/wrap/), +so you should not have to define them. If using a struct for the first time in a higher-level +interface, remember to add tests! You may need to define more functions around the structs. + ## Mapping to Metal Intrinsics Some Metal functions map directly to Apple intermediate representation intrinsics. In this @@ -134,4 +138,4 @@ their free time helping out. Most anything you're able to do is helpful, but if stuck, seek guidance from Slack or Discourse. Don't feel like your contribution has to be perfect. If you put in effort and make progress, there will likely be some senior developer willing to polish your code before merging. Open-source software is a team effort...welcome -to the team! \ No newline at end of file +to the team! diff --git a/res/wrap/README.md b/res/wrap/README.md index 70a1c6bcc..1c8852e32 100644 --- a/res/wrap/README.md +++ b/res/wrap/README.md @@ -2,11 +2,11 @@ This directory contains scripts to generate Julia wrappers for Metal and MetalPerformanceShaders. -Currently, only `enums` and `structs` are able to be generated. +Currently, only `enums` and `structs` are able to be generated. Don't forget to update the wrappers section in the contributing docs if this changes! The scripts are meant to be run from this directory, and at the moment, [this Clang.jl branch](https://github.com/christiangnrd/Clang.jl/tree/objectiveC) must be used. -#### +-------- Comment from removed file on `MTLDataType`. Parsing the headers does not reveal these hidden values.